Docs Process: Add TW processes and docs contributor guide DRAFT #1117
+978
−10
Conversation
This file contains hidden or 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
Vercel Previews Deployed
|
aimeeu
commented
Oct 30, 2025
boruszak
reviewed
Oct 30, 2025
docs/contribute.md
Outdated
|
|
||
| ### Workflows | ||
|
|
||
| @TODO use which presentation?? |
There was a problem hiding this comment.
List, but get rid of the sentence after the colon, and make each item a link to the workflow.
aimeeu
commented
Nov 4, 2025
| --- | ||
| ``` | ||
|
|
||
| This repository's content guide includes detailed instructions on how to [create a new page and add it to the navigation sidebar](/content--guide/create-new-page). |
There was a problem hiding this comment.
Suggested change
| This repository's content guide includes detailed instructions on how to [create a new page and add it to the navigation sidebar](/content--guide/create-new-page). | |
| This repository's content guide includes detailed instructions on how to [create a new page and add it to the navigation sidebar](/content-guide/create-new-page). |
fix link
|
|
||
| In our documentation, you can use custom markdown enhancements to produce pages with tabs, named code blocks, badges, and alert boxes. | ||
|
|
||
| Correct usage of these enhancements is documented in this repo's [content style guide](/style-guide). The custom components and additional configuration options are avaialble using the `dev-portal` repo. |
There was a problem hiding this comment.
Suggested change
| Correct usage of these enhancements is documented in this repo's [content style guide](/style-guide). The custom components and additional configuration options are avaialble using the `dev-portal` repo. | |
| Correct usage of these enhancements is documented in this repo's [content style guide](/style-guide). |
Suggest removing "The custom...." sentence. Content contributors don't need to know the DevDot underlying architecture in order to use the custom components, and this sentence makes me think I might have to do something with the dev-portal project in order to use custom components.
|
|
||
| ## Navigation sidebars | ||
|
|
||
| The structure of the sidebars are controlled by files in the `./content/<product>/<version>/<data>` directory. Each file contains a configuration for a section of product documentation. For example, `docs-nav-data.json` controls navigation in the product's `Documentation` section on developer.hashicorp.com. |
There was a problem hiding this comment.
Suggested change
| The structure of the sidebars are controlled by files in the `./content/<product>/<version>/<data>` directory. Each file contains a configuration for a section of product documentation. For example, `docs-nav-data.json` controls navigation in the product's `Documentation` section on developer.hashicorp.com. | |
| The structure of the sidebars is controlled by files in the `./content/<product>/<version>/<data>` directory. Each file contains a configuration for a section of product documentation. For example, `docs-nav-data.json` controls navigation in the product's `Documentation` section on developer.hashicorp.com. |
|
|
||
| Correct usage of these enhancements is documented in this repo's [content style guide](/style-guide). The custom components and additional configuration options are avaialble using the `dev-portal` repo. | ||
|
|
||
| ## Navigation sidebars |
There was a problem hiding this comment.
Do we need to duplicate this here when it's in the create-new-page file? Probably safe to say that the majority of contributors aren't going to be modifying the sidebar files. Potentially less confusing to keep all the sidebar content with the create new page content.
| - An `index.mdx` file is not required for each subdirectory. | ||
| - If you use `index.mdx` files: you must add the file to the navigation `.json`, but the `.json` file can resolve it from the name of the directory. In the example, notice that it uses the `directory` path rather than `directory/index`. A common convention is to set the `title` of an index node to be `"Overview"`. | ||
|
|
||
| ### Custom or external links |
There was a problem hiding this comment.
Suggest moving this section to create-new-page file.
|
|
||
| ## Redirects | ||
|
|
||
| Detailed guidance on redirects and formatting is available in the [content guide](/content-guide/redirects). |
There was a problem hiding this comment.
Suggested change
| Detailed guidance on redirects and formatting is available in the [content guide](/content-guide/redirects). | |
| Find detailed guidance on redirects and formatting in the [content guide](/content-guide/redirects). |
active voice
Co-authored-by: Jeff Boruszak <[email protected]>
aimeeu
commented
Nov 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Jira: CE-1062
I copied content from Confluence wikis TW content types, web-unified-docs reference, How to contribute to Vault docs and sidebar explanation from nomad/website/README.
Previews: