Skip to content

docs: fix Helm README Kubernetes link#41693

Open
suyua9 wants to merge 2 commits intoappsmithorg:releasefrom
suyua9:suyua9-fix-helm-readme-link
Open

docs: fix Helm README Kubernetes link#41693
suyua9 wants to merge 2 commits intoappsmithorg:releasefrom
suyua9:suyua9-fix-helm-readme-link

Conversation

@suyua9
Copy link
Copy Markdown

@suyua9 suyua9 commented Apr 3, 2026

Summary

  • add the missing https:// scheme to the Kubernetes link in deploy/helm/README.md

Problem

The Helm README currently links Kubernetes as [Kubernetes](kubernetes.io), which renders as a relative link instead of opening the Kubernetes website.

Solution

  • update the Markdown link target to https://kubernetes.io

Communication

Should the DevRel and Marketing teams inform users about this change?

  • Yes
  • No

Summary by CodeRabbit

  • Documentation
    • Updated deployment docs to use explicit HTTPS for the main Kubernetes reference link.
    • Replaced the kubectl installation link with an explicit HTTPS target to ensure secure, direct referencing.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 3, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 75511c13-8609-4f11-80b3-a124732ce4f9

📥 Commits

Reviewing files that changed from the base of the PR and between 9002435 and 0b78cd8.

📒 Files selected for processing (1)
  • deploy/helm/README.md
✅ Files skipped from review due to trivial changes (1)
  • deploy/helm/README.md

Walkthrough

Updated two Markdown link targets in deploy/helm/README.md to use explicit https:// URLs for the Kubernetes references (changed link targets only).

Changes

Cohort / File(s) Summary
Documentation
deploy/helm/README.md
Replaced protocol-less Kubernetes links with explicit https:// targets in Introduction and Prerequisites (two link target edits).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A bare link got a cloak of HTTPS,
Now it travels safe across the net,
Small edit, tidy and neat,
Documentation walking on steady feet,
A tiny fix — the web's little treat.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: fixing a Kubernetes link in the Helm README by adding the https:// protocol.
Description check ✅ Passed The description provides summary, problem statement, and solution with clear motivation. However, it deviates from the template structure and lacks some template sections like issue reference and Notion/Figma links, though these may not be applicable to this minor documentation fix.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
deploy/helm/README.md (1)

25-25: ⚠️ Potential issue | 🟡 Minor

Same link issue exists here.

Line 25 has the same problem that was fixed on line 19 - the link is missing the https:// protocol and will render as a relative link.

🔗 Proposed fix
-    * Install kubectl: [kubernetes.io/vi/docs/tasks/tools/install-kubectl/](https://kubernetes.io/vi/docs/tasks/tools/install-kubectl/)
+    * Install kubectl: [https://kubernetes.io/vi/docs/tasks/tools/install-kubectl/](https://kubernetes.io/vi/docs/tasks/tools/install-kubectl/)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@deploy/helm/README.md` at line 25, The markdown link for "Install kubectl" is
missing the protocol and is rendering as a relative link; update the link target
so it includes the full URL
(https://kubernetes.io/vi/docs/tasks/tools/install-kubectl/) instead of the
current relative path, mirroring the fix applied earlier for the other link.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@deploy/helm/README.md`:
- Line 25: The markdown link for "Install kubectl" is missing the protocol and
is rendering as a relative link; update the link target so it includes the full
URL (https://kubernetes.io/vi/docs/tasks/tools/install-kubectl/) instead of the
current relative path, mirroring the fix applied earlier for the other link.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b0964894-e3c6-498a-9cd4-0c56d7458b98

📥 Commits

Reviewing files that changed from the base of the PR and between 4325533 and 9002435.

📒 Files selected for processing (1)
  • deploy/helm/README.md

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.

1 participant