VAULT-12564 Docs for token file auth method #18783
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ncabatoff
reviewed
Jan 23, 2023
peteski22
reviewed
Jan 24, 2023
VioletHynes
commented
Jan 24, 2023
| description: Token File Method for Vault Agent Auto-Auth | ||
| --- | ||
|
|
||
| ~> Note: This authentication method is tailored for the development experience. |
There was a problem hiding this comment.
I'm unsure if this should be before or after the header. It was hard to find an example of something similar. Let me know if it would look better below the header!
There was a problem hiding this comment.
I think either option looks good when it comes to aesthetics. For what's it worth, when looking at the page, I noticed that my eyes were immediately drawn to the title (Vault Agent Auto-Auth Token File Method) and I carried on reading from there – not really parsing the note. That makes me think that it could be more noticeable if placed after the header.
There was a problem hiding this comment.
Thanks! I'll make this change.
peteski22
approved these changes
Jan 25, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
To accompany #18740
The salient page can be found here: https://vault-13p4v6q6e-hashicorp.vercel.app/vault/docs/agent/autoauth/methods/token_file