[docs] Restructure home page - #5217
Open
geoffreynyaga wants to merge 3 commits into
Open
Conversation
geoffreynyaga
marked this pull request as ready for review
September 9, 2026 10:09
Contributor
Author
|
@chrisndbg There are missing items from this home page, specifically the topics that currently don't have existing documentation e.g snapshots, Availability Zones, cloud-init etc. Those items will be put in the documentation JIRA backlog and their entries will be added here once their respective PRs get merged |
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
This is another pass at our documentation home page patterns ; specifically the "In this documentation" section itself. It follows a few team workshops and rounds of ideation, so what's here is what we agreed on together.
NOTE: The table of contents is now built with a Sphinx extension called sphinx-structured-toc instead of the usual Markdown format.
The page is organized around a few notable (and new) sections.
Related Issue(s)
Closes # (issue number)
Testing
Unit tests
Manual testing steps:
make spellcheckpassesmake linkcheckpassesScreenshots (if applicable)
Checklist