Merge branch 'main' into nrichu-hcp-doc-patch

hashicorp · Jan 25, 2023 · a06e68b · a06e68b
2 parents bf5a4ed + 6e425f7
commit a06e68b
Show file tree

Hide file tree

Showing 407 changed files with 4,031 additions and 3,998 deletions.
diff --git a/.github/workflows/check-legacy-links-format.yml b/.github/workflows/check-legacy-links-format.yml
@@ -0,0 +1,17 @@
+name: Legacy Link Format Checker
+
+on:
+  push:
+    paths:
+      - "website/content/**/*.mdx"
+      - "website/data/*-nav-data.json"
+
+jobs:
+  check-links:
+    uses: hashicorp/dev-portal/.github/workflows/docs-content-check-legacy-links-format.yml@475289345d312552b745224b46895f51cc5fc490
+    with:
+      repo-owner: "hashicorp"
+      repo-name: "consul"
+      commit-sha: ${{ github.sha }}
+      mdx-directory: "website/content"
+      nav-data-directory: "website/data"
diff --git a/.github/workflows/test-link-rewrites.yml b/.github/workflows/test-link-rewrites.yml
@@ -0,0 +1,16 @@
+name: Test Link Rewrites
+
+on: [deployment_status]
+
+jobs:
+  test-link-rewrites:
+    if: github.event.deployment_status.state == 'success'
+    uses: hashicorp/dev-portal/.github/workflows/docs-content-link-rewrites-e2e.yml@2aceb60125f6c15f4c8dbe2e4d79148047bfa437
+    with:
+      repo-owner: "hashicorp"
+      repo-name: "consul"
+      commit-sha: ${{ github.sha }}
+      main-branch-preview-url: "https://consul-git-main-hashicorp.vercel.app/"
+      # Workflow is only intended to run for one single migration PR
+      # This variable does not need to be updated
+      pr-branch-preview-url: "https://consul-git-docs-ambmigrate-link-formats-hashicorp.vercel.app/"
diff --git a/website/content/api-docs/acl/auth-methods.mdx b/website/content/api-docs/acl/auth-methods.mdx
@@ -14,7 +14,7 @@ The `/acl/auth-method` endpoints [create](#create-an-auth-method),
 ACL auth methods in Consul.
 
 For more information on how to setup ACLs, please check
-the [ACL tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production).
+the [ACL tutorial](/consul/tutorials/security/access-control-setup-production).
 
 ## Create an Auth Method
 
@@ -25,16 +25,16 @@ This endpoint creates a new ACL auth method.
 | `PUT`  | `/acl/auth-method` | `application/json` |
 
 The table below shows this endpoint's support for
-[blocking queries](/api-docs/features/blocking),
-[consistency modes](/api-docs/features/consistency),
-[agent caching](/api-docs/features/caching), and
-[required ACLs](/api-docs/api-structure#authentication).
+[blocking queries](/consul/api-docs/features/blocking),
+[consistency modes](/consul/api-docs/features/consistency),
+[agent caching](/consul/api-docs/features/caching), and
+[required ACLs](/consul/api-docs/api-structure#authentication).
 
 | Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
 | ---------------- | ----------------- | ------------- | ------------ |
 | `NO`             | `none`            | `none`        | `acl:write`  |
 
-The corresponding CLI command is [`consul acl auth-method create`](/commands/acl/auth-method/create).
+The corresponding CLI command is [`consul acl auth-method create`](/consul/commands/acl/auth-method/create).
 
 ### Query Parameters
 
@@ -49,7 +49,7 @@ The corresponding CLI command is [`consul acl auth-method create`](/commands/acl
 
 - `Type` `(string: <required>)` - The type of auth method being configured.
   This field is immutable. For allowed values see the [auth method
-  documentation](/docs/security/acl/auth-methods).
+  documentation](/consul/docs/security/acl/auth-methods).
 
 - `Description` `(string: "")` - Free form human readable description of the
   auth method.
@@ -59,7 +59,7 @@ The corresponding CLI command is [`consul acl auth-method create`](/commands/acl
 
 - `MaxTokenTTL` `(duration: 0s)` - This specifies the maximum life of any token
   created by this auth method. When set it will initialize the
-  [`ExpirationTime`](/api-docs/acl/tokens#expirationtime) field on all tokens
+  [`ExpirationTime`](/consul/api-docs/acl/tokens#expirationtime) field on all tokens
   to a value of `Token.CreateTime + AuthMethod.MaxTokenTTL`. This field is not
   persisted beyond its initial use. Can be specified in the form of `"60s"` or
   `"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
 - `Config` `(map[string]string: <required>)` - The raw configuration to use for
   the chosen auth method. Contents will vary depending upon the type chosen.
   For more information on configuring specific auth method types, see the [auth
-  method documentation](/docs/security/acl/auth-methods).
+  method documentation](/consul/docs/security/acl/auth-methods).
 
 - `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of
   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
 | `GET`  | `/acl/auth-method/:name` | `application/json` |
 
 The table below shows this endpoint's support for
-[blocking queries](/api-docs/features/blocking),
-[consistency modes](/api-docs/features/consistency),
-[agent caching](/api-docs/features/caching), and
-[required ACLs](/api-docs/api-structure#authentication).
+[blocking queries](/consul/api-docs/features/blocking),
+[consistency modes](/consul/api-docs/features/consistency),
+[agent caching](/consul/api-docs/features/caching), and
+[required ACLs](/consul/api-docs/api-structure#authentication).
 
 | Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
 | ---------------- | ----------------- | ------------- | ------------ |
 | `YES`            | `all`             | `none`        | `acl:read`   |
 
-The corresponding CLI command is [`consul acl auth-method read`](/commands/acl/auth-method/read).
+The corresponding CLI command is [`consul acl auth-method read`](/consul/commands/acl/auth-method/read).
 
 ### Path Parameters
 
@@ -208,16 +208,16 @@ This endpoint updates an existing ACL auth method.
 | `PUT`  | `/acl/auth-method/:name` | `application/json` |
 
 The table below shows this endpoint's support for
-[blocking queries](/api-docs/features/blocking),
-[consistency modes](/api-docs/features/consistency),
-[agent caching](/api-docs/features/caching), and
-[required ACLs](/api-docs/api-structure#authentication).
+[blocking queries](/consul/api-docs/features/blocking),
+[consistency modes](/consul/api-docs/features/consistency),
+[agent caching](/consul/api-docs/features/caching), and
+[required ACLs](/consul/api-docs/api-structure#authentication).
 
 | Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
 | ---------------- | ----------------- | ------------- | ------------ |
 | `NO`             | `none`            | `none`        | `acl:write`  |
 
-The corresponding CLI command is [`consul acl auth-method update`](/commands/acl/auth-method/update).
+The corresponding CLI command is [`consul acl auth-method update`](/consul/commands/acl/auth-method/update).
 
 ### Path Parameters
 
@@ -246,7 +246,7 @@ The corresponding CLI command is [`consul acl auth-method update`](/commands/acl
 
 - `MaxTokenTTL` `(duration: 0s)` - This specifies the maximum life of any token
   created by this auth method. When set it will initialize the
-  [`ExpirationTime`](/api-docs/acl/tokens#expirationtime) field on all tokens
+  [`ExpirationTime`](/consul/api-docs/acl/tokens#expirationtime) field on all tokens
   to a value of `Token.CreateTime + AuthMethod.MaxTokenTTL`. This field is not
   persisted beyond its initial use. Can be specified in the form of `"60s"` or
   `"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
 - `Config` `(map[string]string: <required>)` - The raw configuration to use for
   the chosen auth method. Contents will vary depending upon the type chosen.
   For more information on configuring specific auth method types, see the [auth
-  method documentation](/docs/security/acl/auth-methods).
+  method documentation](/consul/docs/security/acl/auth-methods).
 
 - `Namespace` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of
   the auth method you update. This field takes precedence over the `ns` query parameter,
@@ -336,8 +336,8 @@ $ curl --request PUT \
 This endpoint deletes an ACL auth method.
 
 ~> Deleting an auth method will also immediately delete all associated
-[binding rules](/api-docs/acl/binding-rules) as well as any
-outstanding [tokens](/api-docs/acl/tokens) created from this auth method.
+[binding rules](/consul/api-docs/acl/binding-rules) as well as any
+outstanding [tokens](/consul/api-docs/acl/tokens) created from this auth method.
 
 | Method   | Path                     | Produces           |
 | -------- | ------------------------ | ------------------ |
@@ -347,16 +347,16 @@ Even though the return type is application/json, the value is either true or
 false indicating whether the delete succeeded.
 
 The table below shows this endpoint's support for
-[blocking queries](/api-docs/features/blocking),
-[consistency modes](/api-docs/features/consistency),
-[agent caching](/api-docs/features/caching), and
-[required ACLs](/api-docs/api-structure#authentication).
+[blocking queries](/consul/api-docs/features/blocking),
+[consistency modes](/consul/api-docs/features/consistency),
+[agent caching](/consul/api-docs/features/caching), and
+[required ACLs](/consul/api-docs/api-structure#authentication).
 
 | Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
 | ---------------- | ----------------- | ------------- | ------------ |
 | `NO`             | `none`            | `none`        | `acl:write`  |
 
-The corresponding CLI command is [`consul acl auth-method delete`](/commands/acl/auth-method/delete).
+The corresponding CLI command is [`consul acl auth-method delete`](/consul/commands/acl/auth-method/delete).
 
 ### Path Parameters
 
@@ -389,16 +389,16 @@ This endpoint lists all the ACL auth methods.
 | `GET`  | `/acl/auth-methods` | `application/json` |
 
 The table below shows this endpoint's support for
-[blocking queries](/api-docs/features/blocking),
-[consistency modes](/api-docs/features/consistency),
-[agent caching](/api-docs/features/caching), and
-[required ACLs](/api-docs/api-structure#authentication).
+[blocking queries](/consul/api-docs/features/blocking),
+[consistency modes](/consul/api-docs/features/consistency),
+[agent caching](/consul/api-docs/features/caching), and
+[required ACLs](/consul/api-docs/api-structure#authentication).
 
 | Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
 | ---------------- | ----------------- | ------------- | ------------ |
 | `YES`            | `all`             | `none`        | `acl:read`   |
 
-The corresponding CLI command is [`consul acl auth-method list`](/commands/acl/auth-method/list).
+The corresponding CLI command is [`consul acl auth-method list`](/consul/commands/acl/auth-method/list).
 
 ### Query Parameters
 

diff --git a/website/content/api-docs/acl/binding-rules.mdx b/website/content/api-docs/acl/binding-rules.mdx
@@ -14,7 +14,7 @@ The `/acl/binding-rule` endpoints [create](#create-a-binding-rule),
 rules in Consul.
 
 For more information on how to setup ACLs, please check
-the [ACL tutorial](https://learn.hashicorp.com/tutorials/consul/access-control-setup-production).
+the [ACL tutorial](/consul/tutorials/security/access-control-setup-production).
 
 ## Create a Binding Rule
 
@@ -25,16 +25,16 @@ This endpoint creates a new ACL binding rule.
 | `PUT`  | `/acl/binding-rule` | `application/json` |
 
 The table below shows this endpoint's support for
-[blocking queries](/api-docs/features/blocking),
-[consistency modes](/api-docs/features/consistency),
-[agent caching](/api-docs/features/caching), and
-[required ACLs](/api-docs/api-structure#authentication).
+[blocking queries](/consul/api-docs/features/blocking),
+[consistency modes](/consul/api-docs/features/consistency),
+[agent caching](/consul/api-docs/features/caching), and
+[required ACLs](/consul/api-docs/api-structure#authentication).
 
 | Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
 | ---------------- | ----------------- | ------------- | ------------ |
 | `NO`             | `none`            | `none`        | `acl:write`  |
 
-The corresponding CLI command is [`consul acl binding-rule create`](/commands/acl/binding-rule/create).
+The corresponding CLI command is [`consul acl binding-rule create`](/consul/commands/acl/binding-rule/create).
 
 ### Query Parameters
 
@@ -154,16 +154,16 @@ response.
 | `GET`  | `/acl/binding-rule/:id` | `application/json` |
 
 The table below shows this endpoint's support for
-[blocking queries](/api-docs/features/blocking),
-[consistency modes](/api-docs/features/consistency),
-[agent caching](/api-docs/features/caching), and
-[required ACLs](/api-docs/api-structure#authentication).
+[blocking queries](/consul/api-docs/features/blocking),
+[consistency modes](/consul/api-docs/features/consistency),
+[agent caching](/consul/api-docs/features/caching), and
+[required ACLs](/consul/api-docs/api-structure#authentication).
 
 | Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
 | ---------------- | ----------------- | ------------- | ------------ |
 | `YES`            | `all`             | `none`        | `acl:read`   |
 
-The corresponding CLI command is [`consul acl binding-rule read`](/commands/acl/binding-rule/read).
+The corresponding CLI command is [`consul acl binding-rule read`](/consul/commands/acl/binding-rule/read).
 
 ### Path Parameters
 
@@ -204,16 +204,16 @@ This endpoint updates an existing ACL binding rule.
 | `PUT`  | `/acl/binding-rule/:id` | `application/json` |
 
 The table below shows this endpoint's support for
-[blocking queries](/api-docs/features/blocking),
-[consistency modes](/api-docs/features/consistency),
-[agent caching](/api-docs/features/caching), and
-[required ACLs](/api-docs/api-structure#authentication).
+[blocking queries](/consul/api-docs/features/blocking),
+[consistency modes](/consul/api-docs/features/consistency),
+[agent caching](/consul/api-docs/features/caching), and
+[required ACLs](/consul/api-docs/api-structure#authentication).
 
 | Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
 | ---------------- | ----------------- | ------------- | ------------ |
 | `NO`             | `none`            | `none`        | `acl:write`  |
 
-The corresponding CLI command is [`consul acl binding-rule update`](/commands/acl/binding-rule/update).
+The corresponding CLI command is [`consul acl binding-rule update`](/consul/commands/acl/binding-rule/update).
 
 ### Path Parameters
 
@@ -342,16 +342,16 @@ Even though the return type is application/json, the value is either true or
 false indicating whether the delete succeeded.
 
 The table below shows this endpoint's support for
-[blocking queries](/api-docs/features/blocking),
-[consistency modes](/api-docs/features/consistency),
-[agent caching](/api-docs/features/caching), and
-[required ACLs](/api-docs/api-structure#authentication).
+[blocking queries](/consul/api-docs/features/blocking),
+[consistency modes](/consul/api-docs/features/consistency),
+[agent caching](/consul/api-docs/features/caching), and
+[required ACLs](/consul/api-docs/api-structure#authentication).
 
 | Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
 | ---------------- | ----------------- | ------------- | ------------ |
 | `NO`             | `none`            | `none`        | `acl:write`  |
 
-The corresponding CLI command is [`consul acl binding-rule delete`](/commands/acl/binding-rule/delete).
+The corresponding CLI command is [`consul acl binding-rule delete`](/consul/commands/acl/binding-rule/delete).
 
 ### Path Parameters
 
@@ -384,16 +384,16 @@ This endpoint lists all the ACL binding rules.
 | `GET`  | `/acl/binding-rules` | `application/json` |
 
 The table below shows this endpoint's support for
-[blocking queries](/api-docs/features/blocking),
-[consistency modes](/api-docs/features/consistency),
-[agent caching](/api-docs/features/caching), and
-[required ACLs](/api-docs/api-structure#authentication).
+[blocking queries](/consul/api-docs/features/blocking),
+[consistency modes](/consul/api-docs/features/consistency),
+[agent caching](/consul/api-docs/features/caching), and
+[required ACLs](/consul/api-docs/api-structure#authentication).
 
 | Blocking Queries | Consistency Modes | Agent Caching | ACL Required |
 | ---------------- | ----------------- | ------------- | ------------ |
 | `YES`            | `all`             | `none`        | `acl:read`   |
 
-The corresponding CLI command is [`consul acl binding-rule list`](/commands/acl/binding-rule/list).
+The corresponding CLI command is [`consul acl binding-rule list`](/consul/commands/acl/binding-rule/list).
 
 ## Query Parameters