Alternative fix: make OpenBolt topic-group pages reachable from the navbar#388
Closed
miharp wants to merge 1 commit into
Closed
Alternative fix: make OpenBolt topic-group pages reachable from the navbar#388miharp wants to merge 1 commit into
miharp wants to merge 1 commit into
Conversation
Plans, Tasks, and Bolt Examples each have their own overview page, but the navbar only rendered them as collapsible group headers with no way to reach the page itself. Add an "Overview" link as the first item in each group, matching the existing pattern used by "Modules", and add a short list of sub-topics to each overview page's content, matching the original Puppet Bolt docs. Fixes OpenVoxProject#386 Signed-off-by: Michael Harp <mike@mikeharp.com>
8 tasks
|
FWIW, #387's implementation was specifically made (and tests) to not change the behavior of any nav item without a |
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
2 participants
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.
Short description
Alternative, smaller fix for #386, posted alongside #387 for comparison.
#387 fixes this by teaching
_includes/nav-item.html(the shared sidebar template used by every collection) to render a nav entry as both a clickable link and a collapsible group. This PR instead makes no template changes: it adds an "Overview" link as the first child item inside each of the three affected groups (Plans, Tasks, Bolt Examples), matching the pattern the nav data already uses for "Modules". The group header still only expands/collapses; the overview page becomes reachable via the new child link.Trade-off versus #387: this doesn't make the group header itself clickable (so it doesn't match the original Puppet Bolt docs' click-to-navigate behavior exactly), but it carries zero risk to the shared nav template that every other collection's sidebar depends on.
Also adds a short hand-written list of sub-topics to
plans.md,tasks.md, andbolt_examples.md(matching the original Puppet Bolt docs), rather than #387's approach of a generic Liquid include that reverse-looks-up the nav tree and parses rendered HTML to extract each child's intro paragraph. With only three affected pages that change rarely, a static list is simpler and avoids that include's build-order dependent HTML parsing.Out of scope here (left to #387 or a follow-up): the Bolt-to-OpenBolt branding pass and folding
bolt.mdintoindex.md.