docs: Enable Material capabilities for the published user documentation - #374
Merged
Merged
Conversation
11 tasks
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 published documentation ran a near-stock Material theme: no Markdown extensions were configured and no theme features were enabled. Code and CLI examples had no copy control, headings had no linkable anchors, and readers on an older documentation version got no indication that a newer one exists.
This enables the Material capabilities that close those gaps. It is configuration only, with no page content or prose changes, so the commits can be cherry-picked onto maintained release branches independently of content work.
Related Issue
SPOT-32682
Type of Change
docs: Documentation updateChanges Made
Three commits, each independently buildable and each touching a distinct region of
user-docs/mkdocs.yml:admonition,attr_list,md_in_html,tocpermalinks,pymdownx.details/emoji/highlight/inlinehilite/snippets/superfences/tabbed) give syntax highlighting and heading anchors now, and make callouts, collapsible blocks, content tabs, code annotations, and snippet includes available to later content work.content.code.copy/select/annotate,content.tooltips,navigation.instantplusprefetch/progress,navigation.tracking/top/footer,toc.follow,search.suggest/highlight/share,announce.dismiss) add the copy button on every code block, instant navigation, back-to-top, previous and next links, and a table of contents that follows the reading position.theme.custom_diranduser-docs/overrides/main.html, filling Material'soutdatedblock. Material keeps it hidden and reveals it when mike reports that the reader is not on the current version.Out of scope by design: page content and prose, an "edit this page" action, all mkdocs plugins, and sidebar navigation layout.
cloud/aws.mdandcloud/azure.mdfrom three spaces to four, so they attach to their list items. See the notes below.Testing
task all)Test Details
<ol>each (3 and 5 steps), with the code blocks nested inside their list items.task docs-check(lint, tests,mkdocs build --strict) passes.task lintpasses in full, andtask fmtleaves the tree unchanged.task allwas not run because its integration tests provision real deployments and nothing outside the documentation site changed.language-* highlightwrapper,__spanline spans, and__codelinenoanchors that the clipboard and annotation runtime targets.data-md-component="outdated"with the link to the current version.mainacross all 19 pages. Prose is identical except on the two pages described below.Checklist
task fmtandtask lintuser-docs/for user-facing changes,doc/for contributor-facing changesCHANGELOG.mdfor user-facing changes, including examples for new features when usefulAdditional Notes
This fixes two pages that were silently broken.
cloud/aws.mdandcloud/azure.mdindented six fenced blocks by three spaces inside ordered lists. Stockfenced_codedoes not recognize those fences, somaincurrently publishes them as inline text with a literalbashin front of the command and no code block at all. The same indentation also split each ordered list into separate lists, restarting step numbering at 1.Both symptoms are now addressed. The configuration commits make
pymdownx.superfencesrecognize the fences, and the final content commit re-indents them to four spaces so they attach to their list items. The AWS setup steps render as one continuous list of 3, and the Azure steps as one list of 5, each with its command nested inside the step it belongs to.The content commit is kept separate from the three configuration commits so the two concerns can be cherry-picked independently.
No
CHANGELOG.mdentry: this changes documentation-site presentation, not launcher behavior.announce.dismisstakes effect only once an announcement bar is added. It is included so that the override file introduced here is ready for one.