Skip to content
This repository was archived by the owner on Jan 23, 2026. It is now read-only.

README.md: fix documentation links#749

Merged
mangelajo merged 2 commits intojumpstarter-dev:mainfrom
aesteve-rh:fix-readme-links
Nov 20, 2025
Merged

README.md: fix documentation links#749
mangelajo merged 2 commits intojumpstarter-dev:mainfrom
aesteve-rh:fix-readme-links

Conversation

@aesteve-rh
Copy link
Copy Markdown
Contributor

@aesteve-rh aesteve-rh commented Nov 20, 2025

Summary by CodeRabbit

  • Documentation
    • Updated documentation links in the Kubernetes installation section to new URL paths for Service and Installation guides.
    • Updated Contributing guide link to new URL path.

✏️ Tip: You can customize this high-level summary in your review settings.

Signed-off-by: Albert Esteve <aesteve@redhat.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Nov 20, 2025

Deploy Preview for jumpstarter-docs ready!

Name Link
🔨 Latest commit 5089654
🔍 Latest deploy log https://app.netlify.com/projects/jumpstarter-docs/deploys/691f142adb72100008bfd674
😎 Deploy Preview https://deploy-preview-749--jumpstarter-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Nov 20, 2025

Walkthrough

Documentation links in README.md have been updated to reflect new URL paths. Three links were modified: the Service link in the Kubernetes installation section, the Installation link in the same section, and the Contributing guide link. No functional code changes.

Changes

Cohort / File(s) Summary
Documentation Link Updates
README.md
Updated Service, Installation, and Contributing guide documentation links to new URL paths

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Simple textual edits with no logic or functional implications
  • Only documentation link targets modified

Suggested reviewers

  • mangelajo
  • NickCao

Poem

🐰 Links were tangled, paths not quite right,
So I hopped through docs with all my might!
Each URL now points just where it should,
The garden of knowledge is understood! 📚✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately describes the main change: fixing documentation links in README.md. It is specific, concise, and directly reflects the changeset's primary objective.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 66691f4 and c91d6da.

📒 Files selected for processing (1)
  • README.md (2 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-05-28T15:09:35.768Z
Learnt from: NickCao
Repo: jumpstarter-dev/jumpstarter PR: 463
File: packages/jumpstarter-cli-admin/jumpstarter_cli_admin/get_test.py:270-270
Timestamp: 2025-05-28T15:09:35.768Z
Learning: The jumpstarter CLI is designed to match kubectl's behavior, including returning exit code 0 (success) when no resources are found, rather than exit code 1 (failure).

Applied to files:

  • README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)
  • GitHub Check: Redirect rules - jumpstarter-docs
  • GitHub Check: Header rules - jumpstarter-docs
  • GitHub Check: Pages changed - jumpstarter-docs
  • GitHub Check: pytest-matrix (macos-15, 3.13)
  • GitHub Check: pytest-matrix (macos-15, 3.11)
  • GitHub Check: pytest-matrix (ubuntu-24.04, 3.12)
  • GitHub Check: pytest-matrix (ubuntu-24.04, 3.11)
  • GitHub Check: pytest-matrix (ubuntu-24.04, 3.13)
  • GitHub Check: build
  • GitHub Check: e2e
🔇 Additional comments (1)
README.md (1)

37-37: Documentation links appear structurally correct; recommend final verification before merge.

The documentation site navigation confirms the existence of the "Installation," "Service," and "Contributing" sections, and the /main/ URL structure is active. The three updated links follow a consistent pattern matching other confirmed documentation URLs.

However, since this PR modifies user-facing links in the README, I recommend manually testing these URLs before merging to ensure they resolve and display the intended content.

Also applies to: 39-39, 54-54


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Member

@mangelajo mangelajo left a comment

Choose a reason for hiding this comment

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

ahh nice!, we should make those relative to the specific release of the docs (i.e. release-0.7 , release-0.8, etc..) , but this is already a step in a good direction so let's merge!

@mangelajo mangelajo enabled auto-merge November 20, 2025 13:14
@mangelajo mangelajo merged commit 3d65e4b into jumpstarter-dev:main Nov 20, 2025
18 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants