Add make docs procedure #472
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
Add the tooling for rendering a local preview of the documentation. For more information, refer to https://grafana.com/docs/writers-toolkit/review/. Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
JStickler
approved these changes
Jun 19, 2024
|
For publishing "next" content, we first need to merge https://github.com/grafana/website/pull/20393 to prevent publishing prematurely and then I an install something like https://github.com/grafana/grafana/blob/main/.github/workflows/publish-technical-documentation-next.yml to do the publishing. Do we have an issue somewhere that explains where we want the docs to show up in the website? |
We're having an information architecture meeting on Tuesday to figure that out. |
|
#494 was merged that will sync documentation |
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.
Add the tooling for rendering a local preview of the documentation and a procedure to keep it up to date.
For more information, refer to https://grafana.com/docs/writers-toolkit/review/.
Signed-off-by: Jack Baldry jack.baldry@grafana.com