[skip changelog] Add missing pages to website navigation panel #2904
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
The project includes a documentation website which is generated by the MkDocs static site generator. The site contains a navigation panel which lists the available documentation pages. Rather than being automatically generated from the contents of the `docs` folder, the contents of the navigation panel have been explicitly defined via the MkDocs configuration file. This means that the project contributors must remember to update the configuration file when development work results in the addition or removal of web pages. This was not done when the `config get` and `debug check` commands were added. The web pages are generated as expected, but the missing configuration file entries means that a visitor to the website would never know of their existence, and could only access them by hacking the URL. The missing entries are hereby added to the MkDocs configuration file.
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.
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)configuration.schema.jsonupdated if new parameters are added.What kind of change does this PR introduce?
Bug fix
What is the current behavior?
The project is supplemented by a documentation website which is generated by the MkDocs static site generator. The site contains a navigation panel which lists the available documentation pages.
Rather than being automatically generated from the contents of the
docsfolder, the contents of the navigation panel have been explicitly defined via the MkDocs configuration file. This means that the project contributors must remember to update the configuration file when development work results in the addition or removal of web pages.This was not done when the
config getanddebug checkcommands were added. The web pages for those commands are generated as expected, but the missing configuration file entries means that a visitor to the website would never know of their existence, and can only access them by hacking the URL.What is the new behavior?
Entries for all documentation pages are present in the MkDocs configuration file, which results in all pages being listed in the navigation panel of the website.
Does this PR introduce a breaking change, and is titled accordingly?
No breaking change.