Skip to content

docs: fix broken table-of-contents links in docs/README.md - #771

Open
avneetbansal-aws wants to merge 2 commits into
goharbor:mainfrom
avneetbansal-aws:docs/fix-readme-toc-links
Open

avneetbansal-aws wants to merge 2 commits into
goharbor:mainfrom
avneetbansal-aws:docs/fix-readme-toc-links

Conversation

@avneetbansal-aws

Copy link
Copy Markdown

Several links in docs/README.md point to flat paths, but those pages were reorganized into subdirectories, so the links 404 on GitHub. This corrects the moved-file links under working-with-projects (create-projects, project-configuration, working-with-images), updates the two vulnerability-scanning links that were renamed from image to artifact (scan-individual-artifact.md, scan-all-artifacts.md), and fixes the E2E guide link whose filename switched from underscores to hyphens (e2e-api-python-based-scripting-guide.md).

Three more links still look broken, but the intended target is not obvious, so I left them out and am happy to follow your preferred targets:

  • working-with-projects/managing-helm-charts.md: the chart museum was replaced by OCI, so the likely replacement is working-with-projects/working-with-oci/working-with-helm-oci-charts.md. That is a content decision rather than a pure link fix.
  • administration/upgrade/upgrade-migrate-data.md: the upgrade section was restructured into _index.md, helm-upgrade.md, roll-back-upgrade.md, and upgrade-test.md. Pointing at _index.md would work if that matches your intent.
  • build-customize-contribute/configure-swagger.md: no matching page exists in that directory (only swagger.yaml), so I was not sure what the link should resolve to.

Note this README is labelled as the Harbor 2.1.x table of contents; if it is considered legacy I am glad to adjust or drop the change as you see fit.

Signed-off-by: avneetbansal-aws <284363899+avneetbansal-aws@users.noreply.github.com>
@avneetbansal-aws
avneetbansal-aws force-pushed the docs/fix-readme-toc-links branch from ea7a273 to 838be1a Compare October 8, 2026 15:06

@chlins chlins left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@chlins
chlins enabled auto-merge (squash) October 10, 2026 03:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants