Open
Conversation
gardener-prow
bot
added
kind/cleanup
gardener-github-actions
bot
added
the
ok-to-test
github-actions
bot
added
needs-ok-to-test
Contributor
🚀 Preview DeployedYour preview is being built and will be available at: Note: The preview will only be available after the GitHub Pages deployment completes in the demo repository. To view the deployment status, visit: https://github.com/gardener/documentation-demo/actions |
|
LGTM label has been added. DetailsGit tree hash: beb50f53759c08150171590682ee28f6a847726c |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: n-boshnakov The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
gardener-prow
bot
added
the
approved
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.
How to categorize this PR?
/kind cleanup enhancement task
What this PR does / why we need it:
In the context of #732, we noticed that some documentation pages are not visible in the sidebar.
This problem occurs in the
Documentationsection of the page, but not in other sections such asBlogorCommunity, which have distinct sidebars.While reviewing the sidebar processing logic, I noticed that pages go missing after the call to
promoteSingleChildLeafs, which is only used for theDocumentationsidebar, not others. As a simplification measure, I propose removing this logic entirely. If we don't want single-child leafs in certain parts of the documentation, that structure should be changed at the source location (e.g., https://github.com/gardener/gardener/tree/master/docs/usage/reference, https://github.com/gardener/gardener/tree/master/docs/usage/gardener).Additionally, I updated the Markdown for two pages to use a more consistent heading structure (starting with
h1, etc.) and made a few minor improvements, since these pages weren't visible in the rendered version before.Which issue(s) this PR fixes:
Fixes #732
Special notes for your reviewer:
I performed a manual side-by-side check between the sidebar rendered with the branch of this PR and our deployed version on
gardener.cloud. Only new pages are now visible that were previously not visible. Otherwise, the structure remains unchanged, and no page is lost.Supersedes:
ℹ️ @LibenHailu
/cc @klocke-io @n-boshnakov