Repository navigation
Conversation
The website perses.dev reads docs/nav.yaml to build the navigation of each published version of the documentation, so the navigation evolves with the documentation (see perses/website#171). Signed-off-by: Augustin Husson <augustin.husson@amadeus.com>
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.
Description
The new website perses.dev (perses/website#171) reads
docs/nav.yamlto build the navigation of each published version of the documentation, so the navigation evolves with the documentation of each version. Until a version contains this file, the website uses a copy of the navigation maintained in the website repository.The content of this file is the navigation currently used by the website for the latest version. A header explains the syntax, close to the
navsection of mkdocs:From now on, when a page is added, moved or removed in
docs/,docs/nav.yamlshould be updated in the same PR. A page missing from the navigation is still published, but can only be reached through links and the search.I validated the file with the website: it is picked up, every page of
docs/is referenced and every entry resolves to an existing page.Screenshots
N/A
Checklist
[<catalog_entry>] <commit message>naming convention using one of thefollowing
catalog_entryvalues:FEATURE,ENHANCEMENT,BUGFIX,BREAKINGCHANGE,DOC,IGNORE.