add link checker, fix broken links (#8326)
This commit is contained in:
Jeff Escalante
GitHub
parent
3043c3b14a
commit
8890885b0d
|
|
@ -72,12 +72,12 @@ description: "A thorough, yet succinct description of the page's contents"
|
|||
The significant keys in the YAML frontmatter are:
|
||||
|
||||
- `title` `(string)` - This is the title of the page that will be set in the
|
||||
HTML title.
|
||||
HTML title.
|
||||
- `description` `(string)` - This is a description of the page that will be set
|
||||
in the HTML description.
|
||||
in the HTML description.
|
||||
|
||||
> ⚠️Since `api` is a reserved directory within NextJS, all `/api/**` pages are
|
||||
listed under the `/pages/api-docs` path.
|
||||
> listed under the `/pages/api-docs` path.
|
||||
|
||||
### Editing Sidebars
|
||||
|
||||
|
|
@ -92,9 +92,9 @@ by the appropriate embedded `content` values.
|
|||
|
||||
- `category` values will be **directory names** within the `pages` directory
|
||||
- `content` values will be **file names** within their appropriately nested
|
||||
directory.
|
||||
directory.
|
||||
|
||||
### Deployment
|
||||
## Deployment
|
||||
|
||||
This website is hosted on Netlify and configured to automatically deploy anytime
|
||||
you push code to the `stable-website` branch. Any time a pull request is
|
||||
|
|
@ -103,6 +103,10 @@ will appear in the github checks which can be used to validate the way docs
|
|||
changes will look live. Deployments from `stable-website` will look and behave
|
||||
the same way as deployment previews.
|
||||
|
||||
## Checking for Broken Links
|
||||
|
||||
There is a local script that can be used to check for broken links on the _current product website_ - you can start it by running `npm run linkcheck`. There will be a version of this script added as a github check in the near future!
|
||||
|
||||
## Known Issues
|
||||
|
||||
### Creating New Pages
|
||||
|
|
|
|||
6
website/package-lock.json
generated
6
website/package-lock.json
generated
|
|
@ -5368,6 +5368,12 @@
|
|||
"resolved": "https://registry.npmjs.org/damerau-levenshtein/-/damerau-levenshtein-1.0.6.tgz",
|
||||
"integrity": "sha512-JVrozIeElnj3QzfUIt8tB8YMluBJom4Vw9qTPpjGYQ9fYlB3D/rb6OordUxf3xeFB35LKWs0xqcO5U6ySvBtug=="
|
||||
},
|
||||
"dart-linkcheck": {
|
||||
"version": "2.0.12",
|
||||
"resolved": "https://registry.npmjs.org/dart-linkcheck/-/dart-linkcheck-2.0.12.tgz",
|
||||
"integrity": "sha512-ReLhme4n6r1v47QcZgkz0yxrJ8qkSRMaHwichzK96OdwOMZ9DY4hHfHAnsLh2vU1rnYCwaVfo1LwwdnAM+nrzw==",
|
||||
"dev": true
|
||||
},
|
||||
"date-fns": {
|
||||
"version": "1.30.1",
|
||||
"resolved": "https://registry.npmjs.org/date-fns/-/date-fns-1.30.1.tgz",
|
||||
|
|
|
|||
|
|
@ -40,6 +40,7 @@
|
|||
"stringify-object": "^3.3.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"dart-linkcheck": "^2.0.12",
|
||||
"glob": "^7.1.6",
|
||||
"husky": "^4.2.3",
|
||||
"inquirer": "^7.0.4",
|
||||
|
|
@ -60,6 +61,7 @@
|
|||
"lint": "next-hashicorp lint",
|
||||
"start": "npm run clear_babel_cache && next dev",
|
||||
"static": "npm run clear_babel_cache && npm run build && npm run export && cp _redirects out/.",
|
||||
"clear_babel_cache": "rm -rf .next/cache/next-babel-loader"
|
||||
"clear_babel_cache": "rm -rf .next/cache/next-babel-loader",
|
||||
"linkcheck": "linkcheck https://www.vaultproject.io"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ may still change significantly over time. Please always run Helm with
|
|||
of Vault. This provides a less complicated out-of-box experience for new users,
|
||||
but is not appropriate for a production setup. It is highly recommended to use
|
||||
a [properly secured Kubernetes cluster](https://kubernetes.io/docs/tasks/administer-cluster/securing-a-cluster/).
|
||||
See the [architecture reference](/docs/platform/k8s/run#architecture)
|
||||
See the [architecture reference](/docs/platform/k8s/helm/run#architecture)
|
||||
for a Vault Helm production deployment checklist.
|
||||
|
||||
## Using the Helm Chart
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ it is highly recommended that you
|
|||
of Vault. This provides a less complicated out-of-box experience for new users,
|
||||
but is not appropriate for a production setup. It is highly recommended to use
|
||||
a [properly secured Kubernetes cluster](https://kubernetes.io/docs/tasks/administer-cluster/securing-a-cluster/).
|
||||
See the [architecture reference](/docs/platform/k8s/run#architecture)
|
||||
See the [architecture reference](#architecture)
|
||||
for a production deployment checklist.
|
||||
|
||||
## How-To
|
||||
|
|
@ -402,7 +402,7 @@ When upgrading to new versions, new servers with the upgraded version of Vault
|
|||
are brought online. They are attached to the same shared storage backend and
|
||||
unsealed. Then the old servers are destroyed. This reduces the need for remote
|
||||
access and upgrade orchestration which may introduce security gaps. See the
|
||||
[upgrade section](/docs/platform/k8s/run#how-to) for instructions
|
||||
[upgrade section](#how-to) for instructions
|
||||
on upgrading Vault on Kubernetes.
|
||||
|
||||
_Upgrade Frequently._ Vault is actively developed, and updating frequently is
|
||||
|
|
|
|||
|
|
@ -248,26 +248,26 @@ Templates are configured on the role and may be optionally encoded as base64.
|
|||
|
||||
The full list of template parameters is shown below:
|
||||
|
||||
| Name | Description |
|
||||
| :--------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- |
|
||||
| `identity.entity.id` | The entity's ID |
|
||||
| `identity.entity.name` | The entity's name |
|
||||
| `identity.entity.groups.ids` | The IDs of the groups the entity is a member of |
|
||||
| `identity.entity.groups.names` | The names of the groups the entity is a member of |
|
||||
| `identity.entity.metadata` | Metadata associated with the entity |
|
||||
| `identity.entity.metadata.<<metadata key>>` | Metadata associated with the entity for the given key |
|
||||
| `identity.entity.aliases.<<mount accessor>>.id` | Entity alias ID for the given mount |
|
||||
| `identity.entity.aliases.<<mount accessor>>.name` | Entity alias name for the given mount |
|
||||
| `identity.entity.aliases.<<mount accessor>>.metadata` | Metadata associated with the alias for the given mount |
|
||||
| `identity.entity.aliases.<<mount accessor>>.metadata.<<metadata key>>` | Metadata associated with the alias for the given mount and metadata key |
|
||||
| `time.now` | Current time as integral seconds since the Epoch |
|
||||
| `time.now.plus.<duration>` | Current time plus a Go-parsable [duration](https://golang.org/pkg/time/#ParseDuration) | |
|
||||
| `time.now.minus.<duration>` | Current time minus a Go-parsable [duration](https://golang.org/pkg/time/#ParseDuration) | |
|
||||
| Name | Description |
|
||||
| :----------------------------------------------------------------- | :-------------------------------------------------------------------------------------- |
|
||||
| `identity.entity.id` | The entity's ID |
|
||||
| `identity.entity.name` | The entity's name |
|
||||
| `identity.entity.groups.ids` | The IDs of the groups the entity is a member of |
|
||||
| `identity.entity.groups.names` | The names of the groups the entity is a member of |
|
||||
| `identity.entity.metadata` | Metadata associated with the entity |
|
||||
| `identity.entity.metadata.<metadata key>` | Metadata associated with the entity for the given key |
|
||||
| `identity.entity.aliases.<mount accessor>.id` | Entity alias ID for the given mount |
|
||||
| `identity.entity.aliases.<mount accessor>.name` | Entity alias name for the given mount |
|
||||
| `identity.entity.aliases.<mount accessor>.metadata` | Metadata associated with the alias for the given mount |
|
||||
| `identity.entity.aliases.<mount accessor>.metadata.<metadata key>` | Metadata associated with the alias for the given mount and metadata key |
|
||||
| `time.now` | Current time as integral seconds since the Epoch |
|
||||
| `time.now.plus.<duration>` | Current time plus a Go-parsable [duration](https://golang.org/pkg/time/#ParseDuration) | |
|
||||
| `time.now.minus.<duration>` | Current time minus a Go-parsable [duration](https://golang.org/pkg/time/#ParseDuration) | |
|
||||
|
||||
### Token Generation
|
||||
|
||||
An authenticated client may request a token using the [token generation
|
||||
endpoint](api/secret/identity/tokens#generate-a-signed-id-token). The token
|
||||
endpoint](/api/secret/identity/tokens#generate-a-signed-id-token). The token
|
||||
will be generated per the requested role's specifications, for the requester's
|
||||
entity. It is not possible to generate tokens for an arbitrary entity.
|
||||
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ export default function SecretsManagmentUseCase() {
|
|||
<div className="slider-frame single">
|
||||
<div className="case-study">
|
||||
<div className="feature-image">
|
||||
<a href="/resources/adobe-100-trillion-transactions-hashicorp-vault">
|
||||
<a href="https://www.hashicorp.com/resources/adobe-100-trillion-transactions-hashicorp-vault">
|
||||
<picture>
|
||||
<source
|
||||
type="image/webp"
|
||||
|
|
@ -91,7 +91,7 @@ export default function SecretsManagmentUseCase() {
|
|||
</p>
|
||||
<a
|
||||
className="g-btn primary-hashicorp-light"
|
||||
href="/resources/adobe-100-trillion-transactions-hashicorp-vault"
|
||||
href="https://www.hashicorp.com/resources/adobe-100-trillion-transactions-hashicorp-vault"
|
||||
>
|
||||
Read Case Study
|
||||
</a>
|
||||
|
|
|
|||
Loading…
Reference in a new issue