Skip to content

Commit 87b3573

Browse files
committed
Add comments to each mdx doc
Comment has been added to all mdx docs that are not partials
1 parent e228610 commit 87b3573

759 files changed

Lines changed: 2277 additions & 0 deletions

File tree

Some content is hidden

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

website/content/api-docs/auth/alicloud.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ page_title: AliCloud - Auth Methods - HTTP API
44
description: This is the API documentation for the Vault AliCloud auth method.
55
---
66

7+
> [!IMPORTANT]
8+
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
9+
710
# AliCloud auth method (API)
811

912
This is the API documentation for the Vault AliCloud auth method. For

website/content/api-docs/auth/approle.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ page_title: AppRole - Auth Methods - HTTP API
44
description: This is the API documentation for the Vault AppRole auth method.
55
---
66

7+
> [!IMPORTANT]
8+
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
9+
710
# AppRole auth method (API)
811

912
This is the API documentation for the Vault AppRole auth method. For

website/content/api-docs/auth/aws.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ page_title: AWS - Auth Methods - HTTP API
44
description: This is the API documentation for the Vault AWS auth method.
55
---
66

7+
> [!IMPORTANT]
8+
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
9+
710
# AWS auth method (API)
811

912
@include 'x509-sha1-deprecation.mdx'

website/content/api-docs/auth/azure.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ description: |-
66
method plugin.
77
---
88

9+
> [!IMPORTANT]
10+
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
11+
912
# Azure auth method (API)
1013

1114
This is the API documentation for the Vault Azure auth method

website/content/api-docs/auth/cert.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ description: |-
66
method.
77
---
88

9+
> [!IMPORTANT]
10+
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
11+
912
# TLS certificate auth method (API)
1013

1114
@include 'x509-sha1-deprecation.mdx'

website/content/api-docs/auth/cf.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ page_title: Cloud Foundry - Auth Methods - HTTP API
44
description: This is the API documentation for the Vault Cloud Foundry auth method.
55
---
66

7+
> [!IMPORTANT]
8+
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
9+
710
# Pivotal Cloud Foundry (CF) auth method (API)
811

912
@include 'x509-sha1-deprecation.mdx'

website/content/api-docs/auth/gcp.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ description: |-
66
method.
77
---
88

9+
> [!IMPORTANT]
10+
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
11+
912
# Google Cloud auth method (API)
1013

1114
This is the API documentation for the Vault Google Cloud auth method. To learn

website/content/api-docs/auth/github.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ page_title: GitHub - Auth Methods - HTTP API
44
description: This is the API documentation for the Vault GitHub auth method.
55
---
66

7+
> [!IMPORTANT]
8+
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
9+
710
# GitHub auth method (API)
811

912
This is the API documentation for the Vault GitHub auth method. For

website/content/api-docs/auth/index.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ description: |-
66
These endpoints are documented in this section.
77
---
88

9+
> [!IMPORTANT]
10+
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
11+
912
# Auth methods
1013

1114
Each auth method publishes its own set of API paths and methods. These endpoints

website/content/api-docs/auth/jwt.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ description: |-
66
method plugin.
77
---
88

9+
> [!IMPORTANT]
10+
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
11+
912
# JWT/OIDC auth method (API)
1013

1114
@include 'x509-sha1-deprecation.mdx'

0 commit comments

Comments
 (0)