docs: Add guide for generating versioned docsets.#442
Open
kapunahelewong wants to merge 1 commit into
Open
Conversation
Collaborator
Author
|
Keeping this in draft mode until I can test it to confirm accuracy. |
86b998c to
bd7ffae
Compare
06a07c5 to
9b76155
Compare
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
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.
Adds an end-to-end guide for generating and publishing a versioned documentation
snapshot for a new Bazel release.
What's in the guide
(Path A:
gen_mdx_release_docs) or needs the older pipeline plusdocs2mdx.py(Path B), with a one-liner to check before startingPython deps for Path B
they differ
{: .external},Jinja-escaped tags, DevSite metadata, non-self-closing void elements) with
exact
sed/perlone-liners</>in prose,<pre>blocks with special characters)dynamically rather than hardcoding a version number
UNSAFE_version stamps, wrong base branch, double-nestedextraction, CLA bot,
command-line-reference.mdxpresubmit failure