-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Closed
Labels
C:docsComponent: DocumentationComponent: Documentation
Description
A follow-up to #7674.
A number of Markdown files in the docs directory, notably the tutorials, link to versions of files at the tip of the master branch instead of the version for which the tutorial is generated. This gives confusing results on the doc site, where the actual contents (and sometimes locations) of files may have diverged on the development head.
It would be nice to automate branching this in some way, since the values may change between versions even within a release branch.
Work Items
- 🆗
Fix up absolute links that point to docs.tendermint.com/master/spec.(we wound up backing out the removal of docs from master, so this is now moot) - Fix up links imported from the spec repo to point to tendermint/tendermint (docs: Update spec links to point to tendermint/tendermint #7851).
- Rewrite the branch-based links on v0.33.x (Update absolute links in v0.33.x to reference that branch. #7887), v0.34.x (Update absolute links in v0.34.x to reference that branch. #7871), and v0.35.x (Update absolute links in v0.35.x to reference that branch. #7870) to target their branch.
- Drop master from the generated docs site entirely (Remove master from the docs site version config. #7874).
- Remove RFC and ADR documents from v0.33.x (Remove ADR docs from the v0.33.x backport branch. #7879), v0.34.x (Remove ADR and RFC docs from the v0.34.x backport branch. #7867), and v0.35.x (Remove ADR and RFC docs from the v0.35.x backport branch. #7866).
- Add to the release docs a step: When cutting a new backport branch, do the same path rewriting for that backport branch (Update release instructions for documentation. #7846).
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
C:docsComponent: DocumentationComponent: Documentation