docs(platform): fix section-overview links (README → overview.md)#146
Merged
Conversation
Each api/<section>/README.md overrode url: to the section root, one level shallower than a leaf page. The repo's extra-../ link convention is calibrated for leaf pages at /api/<section>/<leaf>/, so ../<leaf>.md links from a section-root page climbed to /api/<leaf>/ and 404'd on the live site. Convert all api subsection READMEs to the working leaf pattern used by guides/*/overview.md: rename to overview.md, drop the url: override and the aliases block, and rename the menu identifier -readme -> -overview. Section roots now fall back to the empty _index.md, same as guides. Repoint the top-level api/README.md numbered table from ../api/<section>/ to ../api/<section>/overview/ so it lands on the overview content. Signed-off-by: Arnob kumar saha <arnob@appscode.com>
tamalsaha
requested changes
Jul 14, 2026
tamalsaha
left a comment
tamalsaha
left a comment
Member
There was a problem hiding this comment.
Why switch to the overview again?
Signed-off-by: Arnob kumar saha <arnob@appscode.com>
|
Visit the preview URL for this PR (updated for commit 2b73177): https://kubedb-v2-hugo--pr146-arnob-api-overview-jwaobwsp.web.app (expires Tue, 21 Jul 2026 12:50:36 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 0f29ae8ae0bd54a99bf2b223b6833be47acd5943 |
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.
Problem
The "Pages" links on every API section overview 404 on the live site (reported for
multicluster-ocm, but affects all sections).Root cause: each
api/<section>/README.mdoverridesurl:to the section root (/api/<section>/), one level shallower than a normal leaf page. The repo's intentional extra-../link convention is calibrated for leaf pages at/api/<section>/<leaf>/, so a../<leaf>.mdlink from a section-root page climbs to/api/<leaf>/→ 404.Fix
Convert all API subsection READMEs to the proven working leaf pattern used by
guides/*/overview.md:README.md→overview.mdurl:override and thealiases:blockapi-<section>-readme→api-<section>-overview/api/<section>/overview/Section roots (
/api/<section>/) now fall back to the empty_index.mdauto-list, same asguides/*.The top-level
api/README.mdstays the/api/landing; its 18 numbered-table links are repointed../api/<section>/→../api/<section>/overview/to land on the overview content.Verification
overview.mdfiles.../…body link in the converted overviews passes CI's strip-one-../check (0 broken).guidesoverview pattern.