Skip to content

Commit 6e425f7

Browse files
ashleemboyerkendallstrautman
ashleemboyer
and
kendallstrautman
authored
docs: Migrate link formats (#15976)
* Adding check-legacy-links-format workflow * Adding test-link-rewrites workflow * Updating docs-content-check-legacy-links-format hash * Migrating links to new format Co-authored-by: Kendall Strautman <[email protected]>
1 parent bb71d04 commit 6e425f7

File tree

407 files changed

+4031
-3998
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

407 files changed

+4031
-3998
lines changed

‎.github/workflows/check-legacy-links-format.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Legacy Link Format Checker
2+
3+
on:
4+
push:
5+
paths:
6+
- "website/content/**/*.mdx"
7+
- "website/data/*-nav-data.json"
8+
9+
jobs:
10+
check-links:
11+
uses: hashicorp/dev-portal/.github/workflows/docs-content-check-legacy-links-format.yml@475289345d312552b745224b46895f51cc5fc490
12+
with:
13+
repo-owner: "hashicorp"
14+
repo-name: "consul"
15+
commit-sha: ${{ github.sha }}
16+
mdx-directory: "website/content"
17+
nav-data-directory: "website/data"

‎.github/workflows/test-link-rewrites.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Test Link Rewrites
2+
3+
on: [deployment_status]
4+
5+
jobs:
6+
test-link-rewrites:
7+
if: github.event.deployment_status.state == 'success'
8+
uses: hashicorp/dev-portal/.github/workflows/docs-content-link-rewrites-e2e.yml@2aceb60125f6c15f4c8dbe2e4d79148047bfa437
9+
with:
10+
repo-owner: "hashicorp"
11+
repo-name: "consul"
12+
commit-sha: ${{ github.sha }}
13+
main-branch-preview-url: "https://consul-git-main-hashicorp.vercel.app/"
14+
# Workflow is only intended to run for one single migration PR
15+
# This variable does not need to be updated
16+
pr-branch-preview-url: "https://consul-git-docs-ambmigrate-link-formats-hashicorp.vercel.app/"

‎website/content/api-docs/acl/auth-methods.mdx‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The `/acl/auth-method` endpoints [create](#create-an-auth-method),
1414
ACL auth methods in Consul.
1515

1616
For more information on how to setup ACLs, please check
17-
the [ACL tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production).
17+
the [ACL tutorial](/consul/tutorials/security/access-control-setup-production).
1818

1919
## Create an Auth Method
2020

@@ -25,16 +25,16 @@ This endpoint creates a new ACL auth method.
2525
| `PUT` | `/acl/auth-method` | `application/json` |
2626

2727
The table below shows this endpoint's support for
28-
[blocking queries](/api-docs/features/blocking),
29-
[consistency modes](/api-docs/features/consistency),
30-
[agent caching](/api-docs/features/caching), and
31-
[required ACLs](/api-docs/api-structure#authentication).
28+
[blocking queries](/consul/api-docs/features/blocking),
29+
[consistency modes](/consul/api-docs/features/consistency),
30+
[agent caching](/consul/api-docs/features/caching), and
31+
[required ACLs](/consul/api-docs/api-structure#authentication).
3232

3333
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
3434
| ---------------- | ----------------- | ------------- | ------------ |
3535
| `NO` | `none` | `none` | `acl:write` |
3636

37-
The corresponding CLI command is [`consul acl auth-method create`](/commands/acl/auth-method/create).
37+
The corresponding CLI command is [`consul acl auth-method create`](/consul/commands/acl/auth-method/create).
3838

3939
### Query Parameters
4040

@@ -49,7 +49,7 @@ The corresponding CLI command is [`consul acl auth-method create`](/commands/acl
4949

5050
- `Type` `(string: <required>)` - The type of auth method being configured.
5151
This field is immutable. For allowed values see the [auth method
52-
documentation](/docs/security/acl/auth-methods).
52+
documentation](/consul/docs/security/acl/auth-methods).
5353

5454
- `Description` `(string: "")` - Free form human readable description of the
5555
auth method.
@@ -59,7 +59,7 @@ The corresponding CLI command is [`consul acl auth-method create`](/commands/acl
5959

6060
- `MaxTokenTTL` `(duration: 0s)` - This specifies the maximum life of any token
6161
created by this auth method. When set it will initialize the
62-
[`ExpirationTime`](/api-docs/acl/tokens#expirationtime) field on all tokens
62+
[`ExpirationTime`](/consul/api-docs/acl/tokens#expirationtime) field on all tokens
6363
to a value of `Token.CreateTime + AuthMethod.MaxTokenTTL`. This field is not
6464
persisted beyond its initial use. Can be specified in the form of `"60s"` or
6565
`"5m"` (i.e., 60 seconds or 5 minutes, respectively). This value must be no
@@ -74,7 +74,7 @@ The corresponding CLI command is [`consul acl auth-method create`](/commands/acl
7474
- `Config` `(map[string]string: <required>)` - The raw configuration to use for
7575
the chosen auth method. Contents will vary depending upon the type chosen.
7676
For more information on configuring specific auth method types, see the [auth
77-
method documentation](/docs/security/acl/auth-methods).
77+
method documentation](/consul/docs/security/acl/auth-methods).
7878

7979
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of
8080
the auth method you create. This field takes precedence over the `ns` query parameter,
@@ -156,16 +156,16 @@ auth method exists with the given name, a 404 is returned instead of a
156156
| `GET` | `/acl/auth-method/:name` | `application/json` |
157157

158158
The table below shows this endpoint's support for
159-
[blocking queries](/api-docs/features/blocking),
160-
[consistency modes](/api-docs/features/consistency),
161-
[agent caching](/api-docs/features/caching), and
162-
[required ACLs](/api-docs/api-structure#authentication).
159+
[blocking queries](/consul/api-docs/features/blocking),
160+
[consistency modes](/consul/api-docs/features/consistency),
161+
[agent caching](/consul/api-docs/features/caching), and
162+
[required ACLs](/consul/api-docs/api-structure#authentication).
163163

164164
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
165165
| ---------------- | ----------------- | ------------- | ------------ |
166166
| `YES` | `all` | `none` | `acl:read` |
167167

168-
The corresponding CLI command is [`consul acl auth-method read`](/commands/acl/auth-method/read).
168+
The corresponding CLI command is [`consul acl auth-method read`](/consul/commands/acl/auth-method/read).
169169

170170
### Path Parameters
171171

@@ -208,16 +208,16 @@ This endpoint updates an existing ACL auth method.
208208
| `PUT` | `/acl/auth-method/:name` | `application/json` |
209209

210210
The table below shows this endpoint's support for
211-
[blocking queries](/api-docs/features/blocking),
212-
[consistency modes](/api-docs/features/consistency),
213-
[agent caching](/api-docs/features/caching), and
214-
[required ACLs](/api-docs/api-structure#authentication).
211+
[blocking queries](/consul/api-docs/features/blocking),
212+
[consistency modes](/consul/api-docs/features/consistency),
213+
[agent caching](/consul/api-docs/features/caching), and
214+
[required ACLs](/consul/api-docs/api-structure#authentication).
215215

216216
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
217217
| ---------------- | ----------------- | ------------- | ------------ |
218218
| `NO` | `none` | `none` | `acl:write` |
219219

220-
The corresponding CLI command is [`consul acl auth-method update`](/commands/acl/auth-method/update).
220+
The corresponding CLI command is [`consul acl auth-method update`](/consul/commands/acl/auth-method/update).
221221

222222
### Path Parameters
223223

@@ -246,7 +246,7 @@ The corresponding CLI command is [`consul acl auth-method update`](/commands/acl
246246

247247
- `MaxTokenTTL` `(duration: 0s)` - This specifies the maximum life of any token
248248
created by this auth method. When set it will initialize the
249-
[`ExpirationTime`](/api-docs/acl/tokens#expirationtime) field on all tokens
249+
[`ExpirationTime`](/consul/api-docs/acl/tokens#expirationtime) field on all tokens
250250
to a value of `Token.CreateTime + AuthMethod.MaxTokenTTL`. This field is not
251251
persisted beyond its initial use. Can be specified in the form of `"60s"` or
252252
`"5m"` (i.e., 60 seconds or 5 minutes, respectively). This value must be no
@@ -261,7 +261,7 @@ The corresponding CLI command is [`consul acl auth-method update`](/commands/acl
261261
- `Config` `(map[string]string: <required>)` - The raw configuration to use for
262262
the chosen auth method. Contents will vary depending upon the type chosen.
263263
For more information on configuring specific auth method types, see the [auth
264-
method documentation](/docs/security/acl/auth-methods).
264+
method documentation](/consul/docs/security/acl/auth-methods).
265265

266266
- `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of
267267
the auth method you update. This field takes precedence over the `ns` query parameter,
@@ -336,8 +336,8 @@ $ curl --request PUT \
336336
This endpoint deletes an ACL auth method.
337337

338338
~> Deleting an auth method will also immediately delete all associated
339-
[binding rules](/api-docs/acl/binding-rules) as well as any
340-
outstanding [tokens](/api-docs/acl/tokens) created from this auth method.
339+
[binding rules](/consul/api-docs/acl/binding-rules) as well as any
340+
outstanding [tokens](/consul/api-docs/acl/tokens) created from this auth method.
341341

342342
| Method | Path | Produces |
343343
| -------- | ------------------------ | ------------------ |
@@ -347,16 +347,16 @@ Even though the return type is application/json, the value is either true or
347347
false indicating whether the delete succeeded.
348348

349349
The table below shows this endpoint's support for
350-
[blocking queries](/api-docs/features/blocking),
351-
[consistency modes](/api-docs/features/consistency),
352-
[agent caching](/api-docs/features/caching), and
353-
[required ACLs](/api-docs/api-structure#authentication).
350+
[blocking queries](/consul/api-docs/features/blocking),
351+
[consistency modes](/consul/api-docs/features/consistency),
352+
[agent caching](/consul/api-docs/features/caching), and
353+
[required ACLs](/consul/api-docs/api-structure#authentication).
354354

355355
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
356356
| ---------------- | ----------------- | ------------- | ------------ |
357357
| `NO` | `none` | `none` | `acl:write` |
358358

359-
The corresponding CLI command is [`consul acl auth-method delete`](/commands/acl/auth-method/delete).
359+
The corresponding CLI command is [`consul acl auth-method delete`](/consul/commands/acl/auth-method/delete).
360360

361361
### Path Parameters
362362

@@ -389,16 +389,16 @@ This endpoint lists all the ACL auth methods.
389389
| `GET` | `/acl/auth-methods` | `application/json` |
390390

391391
The table below shows this endpoint's support for
392-
[blocking queries](/api-docs/features/blocking),
393-
[consistency modes](/api-docs/features/consistency),
394-
[agent caching](/api-docs/features/caching), and
395-
[required ACLs](/api-docs/api-structure#authentication).
392+
[blocking queries](/consul/api-docs/features/blocking),
393+
[consistency modes](/consul/api-docs/features/consistency),
394+
[agent caching](/consul/api-docs/features/caching), and
395+
[required ACLs](/consul/api-docs/api-structure#authentication).
396396

397397
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
398398
| ---------------- | ----------------- | ------------- | ------------ |
399399
| `YES` | `all` | `none` | `acl:read` |
400400

401-
The corresponding CLI command is [`consul acl auth-method list`](/commands/acl/auth-method/list).
401+
The corresponding CLI command is [`consul acl auth-method list`](/consul/commands/acl/auth-method/list).
402402

403403
### Query Parameters
404404

‎website/content/api-docs/acl/binding-rules.mdx‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The `/acl/binding-rule` endpoints [create](#create-a-binding-rule),
1414
rules in Consul.
1515

1616
For more information on how to setup ACLs, please check
17-
the [ACL tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production).
17+
the [ACL tutorial](/consul/tutorials/security/access-control-setup-production).
1818

1919
## Create a Binding Rule
2020

@@ -25,16 +25,16 @@ This endpoint creates a new ACL binding rule.
2525
| `PUT` | `/acl/binding-rule` | `application/json` |
2626

2727
The table below shows this endpoint's support for
28-
[blocking queries](/api-docs/features/blocking),
29-
[consistency modes](/api-docs/features/consistency),
30-
[agent caching](/api-docs/features/caching), and
31-
[required ACLs](/api-docs/api-structure#authentication).
28+
[blocking queries](/consul/api-docs/features/blocking),
29+
[consistency modes](/consul/api-docs/features/consistency),
30+
[agent caching](/consul/api-docs/features/caching), and
31+
[required ACLs](/consul/api-docs/api-structure#authentication).
3232

3333
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
3434
| ---------------- | ----------------- | ------------- | ------------ |
3535
| `NO` | `none` | `none` | `acl:write` |
3636

37-
The corresponding CLI command is [`consul acl binding-rule create`](/commands/acl/binding-rule/create).
37+
The corresponding CLI command is [`consul acl binding-rule create`](/consul/commands/acl/binding-rule/create).
3838

3939
### Query Parameters
4040

@@ -154,16 +154,16 @@ response.
154154
| `GET` | `/acl/binding-rule/:id` | `application/json` |
155155

156156
The table below shows this endpoint's support for
157-
[blocking queries](/api-docs/features/blocking),
158-
[consistency modes](/api-docs/features/consistency),
159-
[agent caching](/api-docs/features/caching), and
160-
[required ACLs](/api-docs/api-structure#authentication).
157+
[blocking queries](/consul/api-docs/features/blocking),
158+
[consistency modes](/consul/api-docs/features/consistency),
159+
[agent caching](/consul/api-docs/features/caching), and
160+
[required ACLs](/consul/api-docs/api-structure#authentication).
161161

162162
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
163163
| ---------------- | ----------------- | ------------- | ------------ |
164164
| `YES` | `all` | `none` | `acl:read` |
165165

166-
The corresponding CLI command is [`consul acl binding-rule read`](/commands/acl/binding-rule/read).
166+
The corresponding CLI command is [`consul acl binding-rule read`](/consul/commands/acl/binding-rule/read).
167167

168168
### Path Parameters
169169

@@ -204,16 +204,16 @@ This endpoint updates an existing ACL binding rule.
204204
| `PUT` | `/acl/binding-rule/:id` | `application/json` |
205205

206206
The table below shows this endpoint's support for
207-
[blocking queries](/api-docs/features/blocking),
208-
[consistency modes](/api-docs/features/consistency),
209-
[agent caching](/api-docs/features/caching), and
210-
[required ACLs](/api-docs/api-structure#authentication).
207+
[blocking queries](/consul/api-docs/features/blocking),
208+
[consistency modes](/consul/api-docs/features/consistency),
209+
[agent caching](/consul/api-docs/features/caching), and
210+
[required ACLs](/consul/api-docs/api-structure#authentication).
211211

212212
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
213213
| ---------------- | ----------------- | ------------- | ------------ |
214214
| `NO` | `none` | `none` | `acl:write` |
215215

216-
The corresponding CLI command is [`consul acl binding-rule update`](/commands/acl/binding-rule/update).
216+
The corresponding CLI command is [`consul acl binding-rule update`](/consul/commands/acl/binding-rule/update).
217217

218218
### Path Parameters
219219

@@ -342,16 +342,16 @@ Even though the return type is application/json, the value is either true or
342342
false indicating whether the delete succeeded.
343343

344344
The table below shows this endpoint's support for
345-
[blocking queries](/api-docs/features/blocking),
346-
[consistency modes](/api-docs/features/consistency),
347-
[agent caching](/api-docs/features/caching), and
348-
[required ACLs](/api-docs/api-structure#authentication).
345+
[blocking queries](/consul/api-docs/features/blocking),
346+
[consistency modes](/consul/api-docs/features/consistency),
347+
[agent caching](/consul/api-docs/features/caching), and
348+
[required ACLs](/consul/api-docs/api-structure#authentication).
349349

350350
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
351351
| ---------------- | ----------------- | ------------- | ------------ |
352352
| `NO` | `none` | `none` | `acl:write` |
353353

354-
The corresponding CLI command is [`consul acl binding-rule delete`](/commands/acl/binding-rule/delete).
354+
The corresponding CLI command is [`consul acl binding-rule delete`](/consul/commands/acl/binding-rule/delete).
355355

356356
### Path Parameters
357357

@@ -384,16 +384,16 @@ This endpoint lists all the ACL binding rules.
384384
| `GET` | `/acl/binding-rules` | `application/json` |
385385

386386
The table below shows this endpoint's support for
387-
[blocking queries](/api-docs/features/blocking),
388-
[consistency modes](/api-docs/features/consistency),
389-
[agent caching](/api-docs/features/caching), and
390-
[required ACLs](/api-docs/api-structure#authentication).
387+
[blocking queries](/consul/api-docs/features/blocking),
388+
[consistency modes](/consul/api-docs/features/consistency),
389+
[agent caching](/consul/api-docs/features/caching), and
390+
[required ACLs](/consul/api-docs/api-structure#authentication).
391391

392392
| Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
393393
| ---------------- | ----------------- | ------------- | ------------ |
394394
| `YES` | `all` | `none` | `acl:read` |
395395

396-
The corresponding CLI command is [`consul acl binding-rule list`](/commands/acl/binding-rule/list).
396+
The corresponding CLI command is [`consul acl binding-rule list`](/consul/commands/acl/binding-rule/list).
397397

398398
## Query Parameters
399399

0 commit comments

Comments
 (0)