Skip to content

Fix formatting of the Vault Agent docs#8947

Merged
Valarissa merged 4 commits into
masterfrom
VLTE-331-fix_doc_formatting
May 7, 2020
Merged

Fix formatting of the Vault Agent docs#8947
Valarissa merged 4 commits into
masterfrom
VLTE-331-fix_doc_formatting

Conversation

@Valarissa
Copy link
Copy Markdown

@Valarissa Valarissa commented May 7, 2020

This change just goes through and applies some formatting consistency so it's not a complete mess of broken links and random text artifacts.

To test it, go ahead and do the following:

  • Navigate directory to /website
  • Run make website
  • Point your browser at localhost:3000/docs/agent
  • Review

@Valarissa Valarissa requested a review from a team May 7, 2020 18:32
Comment thread website/pages/docs/agent/index.mdx Outdated
- `listener` <tt>([listener][listener]: <optional\>)</tt> - Specifies the addresses and ports on which the Agent will respond to requests.

- `pid_file` `(string: "")` - Path to the file in which the agent's Process ID
- `pid_file` <tt>(string: "")</tt> - Path to the file in which the agent's Process ID
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In other docs we typically just use tic marks instead of <tt></tt>:

`pid_file` `(string: "")` - Path to the file in which the agent's Process ID

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the <tt></tt> isn't working. Looking at the preview it isn't codifying (string: "")

Screen Shot 2020-05-07 at 12 47 21 PM

@Valarissa Valarissa merged commit 2abfb11 into master May 7, 2020
Valarissa pushed a commit that referenced this pull request May 7, 2020
* Fix formatting of the Vault Agent docs

* Fix up the param definitions with <code> rather than <tt>

* Use <code> only where there is a link embedded, otherwise ticks
sapk pushed a commit to sapk-fork/vault that referenced this pull request Aug 27, 2025
…8933) (hashicorp#8947)

* testing new go-discover logic

* add changelog

* Delete website/content/partials/known-issues/aws-auto-join-fails.mdx

Co-authored-by: JMGoldsmith <spartanaudio@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants