Formatting fixes, structure improvements and page consolidation#24
Merged
Conversation
- getting_started/installconfluent.md replaces the three per-distro install pages, using content tabs for distro-specific steps - advanced_topics/ibinstallxcat.md merges the four near-identical xCAT-based InfiniBand/Omni-Path install walkthroughs - getting_started/ibinstallconfluent.md merges the two confluent-native IB install pages; the duplicated driver-update-media procedure now links the canonical advanced_topics/driverupdatemedia.md - miscellaneous/doca2-10-intstall.md renamed to doca2-10-install.md (filename typo) All old URLs keep working via mkdocs-redirects (new dependency in requirements.txt); navigation and inbound links updated.
Replace the four Inkscape-exported topology diagrams (flat, hierarchy, redundant hierarchy, segmented) with hand-written SVGs in the site's Material red palette: labeled 'confluent collective' / 'managed nodes' containers, numbered node stacks, and text that is readable in both the light and dark theme. Explicit width/height attributes make them open at full size in the lightbox.
Complete the tag taxonomy so every hand-written page carries tags: front matter, adding the new tags xcat, troubleshooting, and drivers.
- Convert standalone 'Note that ...' paragraphs to !!! note (two to !!! warning) admonitions across the affected pages - Link discovery/collective/attribute-expression sub-pages to their main reference pages on first mention - downloads.md: RHEL repo instructions as content tabs, front matter added, redundant link titles removed - developer/api.md: strip redundant bold from headings - user_reference/osdeploy.md: broken HTML Benefits/Drawbacks tables become side-by-side grid cards with Markdown lists - doca3-0/nvidia guides: step lead-ins and phase structure aligned
- Strip shell prompts from command-only code blocks so the copy button yields runnable commands; retag transcript blocks (commands plus output) to the console lexer so prompts render correctly - Convert the remaining indented code blocks to fenced blocks and give every fence a language hint (bash/console/text/ini/apache) - Wrap inline commands, file paths, IP addresses, attribute names and values, package/service names, and example node names in backticks - Remove trailing whitespace, tab indentation, curly quotes, needless escapes, and redundant [url](url) link syntax; fix nested list indentation; fence the previously unfenced makelimitedtls.md content
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
1 participant
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.
Merge redundant install pages and fix doca page filename
getting_started/installconfluent.mdreplaces the three per-distroinstall pages, using content tabs for the distro-specific steps
advanced_topics/ibinstallxcat.mdmerges the four near-identicalxCAT-based InfiniBand/Omni-Path install walkthroughs
getting_started/ibinstallconfluent.mdmerges the two confluent-nativeIB install pages; the duplicated driver-update-media procedure now links
the canonical
driverupdatemedia.mddoca2-10-intstall.mdrenamed todoca2-10-install.md(filename typo)mkdocs-redirects(new dependency inrequirements.txt)Redraw collective architecture diagrams as native SVGs
readable in light and dark themes
Add tags front matter to remaining hand-written pages
xcat,troubleshooting,drivers) so the tags index covers every pageImprove content: admonitions, cross-references, tabs, headings
!!! note/!!! warningadmonitions
downloads.mduses content tabs for the RHEL repo instructions;osdeploy.md's broken HTML tables become side-by-side grid cards;api.mdheadings cleaned upNormalize formatting and code blocks across the docs
#prompts (copy button now yieldsrunnable commands); transcript blocks are retagged to the
consolelexer so prompts render as prompts instead of comments
names; trailing whitespace, tabs, curly quotes, and list indentation
fixed throughout