Skip to content

docs: fix broken/outdated links to application catalog repo (closes #494)#535

Open
Aayushmaan-24 wants to merge 2 commits into
unikraft:mainfrom
Aayushmaan-24:fix-broken-catalog-links-issue494
Open

docs: fix broken/outdated links to application catalog repo (closes #494)#535
Aayushmaan-24 wants to merge 2 commits into
unikraft:mainfrom
Aayushmaan-24:fix-broken-catalog-links-issue494

Conversation

@Aayushmaan-24
Copy link
Copy Markdown

docs: fix broken/outdated links to application catalog examples (#494)

This PR resolves #494 ("Broken links on the homepage and elsewhere to the application catalog") by updating numerous outdated links and references to renamed example paths in the Unikraft catalog repository.

The catalog recently renamed many example directories (e.g., http-go1.21httpserver-go1.21, helloworld-chelloworld-gcc13.2, etc.), causing 404 errors across the homepage, landing components, guides, and hackathon pages. This PR updates all affected links to the current naming convention.

Key Changes

  • Updated quick-link examples on homepage (src/components/language-link.tsx)
  • Fixed catalog strip on homepage (src/components/landing/catalog-strip.tsx)
  • Corrected application links, headings, and trailing slashes in hackathon page (content/hackathons/usw24/index.mdx)
  • Replaced outdated http-go1.21 references with httpserver-go1.21 in all relevant guides:
    • content/guides/using-the-app-catalog.mdx
    • content/guides/catalog-behind-the-scenes.mdx
    • content/guides/catalog-using-firecracker.mdx

Full List of Updated Paths (Summary)

  • examples/helloworld-cexamples/helloworld-gcc13.2
  • examples/http-go1.21examples/httpserver-go1.21
  • examples/http-python3.10-flask3.0examples/flask3.0-python3.10
  • examples/http-node18examples/httpserver-nodejs18
  • examples/http-rust1.75-actix-web4examples/actix4-rust1.75
  • And many more (see commit diff and attached summary file for complete mapping)

Files Left Unchanged

  • Release notes, FAQ, contributing guides, and several other pages still point to valid catalog repo paths or different repositories (e.g., catalog-core).
  • No changes to footer, Discord links, asciinema casts, or library paths that remain valid.

Verification

  • Manually checked updated links against current catalog layout (main branch: /examples and /library directories).
  • All fixed links now resolve correctly or point to appropriate kraft CLI usage patterns.

As discussed on Discord ("Any fixes you do are welcome"), this is my first contribution while preparing for GSoC 2026. Happy to make any adjustments, add more context, or help with related tasks (planning to move to the onboarding guides and catalog-core testing next).

Closes #494
UniKraftBrokenLinksFixes.txt

Copy link
Copy Markdown
Contributor

@razvand razvand left a comment

Choose a reason for hiding this comment

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

Sign off your commit.

Add also a commit body.

See best commit guidelines.

Comment thread tsconfig.json Outdated
Comment thread src/components/landing/catalog-strip.tsx Outdated
Comment thread src/components/landing/catalog-strip.tsx Outdated
Modernized all references to the Unikraft catalog across homepage components, guides and hackathon pages to match current structure.

Addressed mentor review feedback:
- Added trailing newline to tsconfig.json
- Fixed Redis and Lua paths in catalog-strip.tsx

Resolved all markdownlint errors from CI:
- MD104: one sentence per line
- MD031/MD040: blank lines + language specifiers on all fenced blocks
- Split mixed console sessions into separate bash (commands) + text (output)
- MD024: made duplicate headings unique
- MD038, MD007, MD012: cleaned code spans, list indents and extra blanks

Changes kept minimal and targeted.

Closes unikraft#494

Signed-off-by: Aayushmaan <aayushmaan.chakraborty@gmail.com>
@Aayushmaan-24
Copy link
Copy Markdown
Author

All done!

  • Signed-off commit with detailed body (following conventional commit guidelines)
  • Trailing newline added to tsconfig.json
  • Corrected Redis (examples/database-redis7.2) and Lua (library/lua/5.4) paths
  • Fixed all markdownlint errors (blanks around fences, languages added, mixed console blocks split into bash + text, duplicate headings made unique, etc.)

CI should be green now. Ready for final review/merge!

Thank you for the guidance — looking forward to more contributions!

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.

Broken links on the homepage and elsewhere to the application catalog

2 participants