fix(docs): Replace hardcoded `main`-branch references with `DOCS_VAR_CLP_GIT_REF`. by kirkrodrigues · Pull Request #1885 · y-scope/clp

kirkrodrigues · 2026-01-19T11:56:02Z

Description

In the new Kubernetes guide (added in #1827):

The Helm chart we reference and ask users to download is from main, which can go out of sync with a specific release.
There's an unused link reference.

This PR addresses both issues by using DOCS_VAR_CLP_GIT_REF:

The git clone command we ask users to use now includes --branch DOCS_VAR_CLP_GIT_REF so that the specific reference is cloned.
The link to the Helm chart now uses DOCS_VAR_CLP_GIT_REF instead of main.

Checklist

The PR satisfies the contribution guidelines.
This is a breaking change and that has been indicated in the PR title, OR this isn't a
breaking change.
Necessary docs have been updated, OR no docs need to be updated.

Validation performed

task docs:serve
Validated the rendered docs linked to blobs on the current git reference (main).

Summary by CodeRabbit

Documentation
- Updated Kubernetes deployment guide to use branch-specific repository clone instructions.
- Updated Helm chart documentation references to point to branch-specific paths.
- Updated Presto setup guide to use branch-specific repository clone instructions.

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

coderabbitai · 2026-01-19T11:56:16Z

Walkthrough

Repository documentation updates replace hardcoded main-branch references with a branch-specific variable DOCS_VAR_CLP_GIT_REF for clone commands and Helm/chart links in two user guide files.

Changes

Cohort / File(s)	Summary
Kubernetes deployment docs `docs/src/user-docs/guides-k8s-deployment.md`	Replaced `git clone https://github.com/y-scope/clp.git` with `git clone --branch DOCS_VAR_CLP_GIT_REF https://github.com/y-scope/clp.git`; updated CLP Helm chart and values hyperlinks to use `DOCS_VAR_CLP_GIT_REF` branch path.
Presto setup docs `docs/src/user-docs/guides-using-presto.md`	Replaced two `git clone` commands with branch-specific clones using `--branch DOCS_VAR_CLP_GIT_REF` to fetch the repository at the specified ref.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3

✅ 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 accurately reflects the main change: replacing hardcoded main-branch references with a variable across documentation files.
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.}

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.}

coderabbitai

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@docs/src/user-docs/guides-k8s-deployment.md`:
- Around line 586-589: Replace the absolute GitHub URL assigned to the link
reference [clp-helm-chart] with a relative repository path so the docs reference
the in-repo Helm chart at the same commit; locate the link definition for
[clp-helm-chart] and change its target from
"https://github.com/y-scope/clp/tree/DOCS_VAR_CLP_GIT_REF/tools/deployment/package-helm"
to a relative path like "tools/deployment/package-helm/" (or the
doc-build-supported relative syntax) so the docs point to the in-repo chart
instead of a hardcoded GitHub URL.

coderabbitai · 2026-01-19T12:01:13Z

 [aks]: https://azure.microsoft.com/en-us/products/kubernetes-service
 [api-server]: guides-using-the-api-server.md
 [Cilium]: https://cilium.io/
-[clp-helm-chart]: https://github.com/y-scope/clp/tree/main/tools/deployment/package-helm
-[clp-helm-chart-values]: https://github.com/y-scope/clp/blob/main/tools/deployment/package-helm/values.yaml
+[clp-helm-chart]: https://github.com/y-scope/clp/tree/DOCS_VAR_CLP_GIT_REF/tools/deployment/package-helm


🧹 Nitpick | 🔵 Trivial

Prefer a relative repo path for the Helm chart link.

The chart is in-repo; using a relative path keeps docs and referenced files on the same commit and avoids hardcoded GitHub URLs. Based on learnings, consider replacing the GitHub link with a relative path to tools/deployment/package-helm/ if the docs build supports it.

Based on learnings, ...

🤖 Prompt for AI Agents

In `@docs/src/user-docs/guides-k8s-deployment.md` around lines 586 - 589, Replace the absolute GitHub URL assigned to the link reference [clp-helm-chart] with a relative repository path so the docs reference the in-repo Helm chart at the same commit; locate the link definition for [clp-helm-chart] and change its target from "https://github.com/y-scope/clp/tree/DOCS_VAR_CLP_GIT_REF/tools/deployment/package-helm" to a relative path like "tools/deployment/package-helm/" (or the doc-build-supported relative syntax) so the docs point to the in-repo chart instead of a hardcoded GitHub URL.

We're linking to a directory, so it doesn't seem to work with sphinx.

@kirkrodrigues, thank you for the clarification! You're absolutely right—Sphinx doesn't support relative paths for directory links in the same way it does for files. Using the GitHub URL with DOCS_VAR_CLP_GIT_REF is the appropriate solution here, as it still keeps the link version-agnostic (which was the goal of this PR) while working within Sphinx's limitations.

The approach you've taken accomplishes the same goal as using relative paths: ensuring the documentation links point to resources at the correct version/commit.

ヾ(•ω•`)o

✏️ Learnings added

Learnt from: kirkrodrigues Repo: y-scope/clp PR: 1885 File: docs/src/user-docs/guides-k8s-deployment.md:586-589 Timestamp: 2026-01-19T12:06:17.530Z Learning: In the y-scope/clp project documentation built with Sphinx, relative paths work for linking to files within the repository, but directory links require GitHub URLs. When linking to directories (e.g., the Helm chart at tools/deployment/package-helm/), use GitHub URLs with DOCS_VAR_CLP_GIT_REF to keep them version-agnostic.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

🧠 Learnings used

Learnt from: junhaoliao Repo: y-scope/clp PR: 1818 File: tools/deployment/package-helm/templates/configmap.yaml:12-12 Timestamp: 2025-12-19T05:03:42.629Z Learning: In the y-scope/clp Helm chart, the `api_server.host` configuration field in the ConfigMap (tools/deployment/package-helm/templates/configmap.yaml) is unused because no other k8s internal services need to reach the API server—it's only accessed from outside the cluster via NodePort.

Learnt from: Bill-hbrhbr Repo: y-scope/clp PR: 1261 File: docs/src/dev-guide/components-core/manylinux-2-28-deps-install.md:24-24 Timestamp: 2025-08-25T06:32:48.313Z Learning: In the CLP project documentation, when linking to scripts or other files within the repository, use relative paths (e.g., components/core/tools/scripts/...) rather than commit-pinned GitHub URLs to ensure docs and referenced files always belong to the same commit and stay synchronized.

Learnt from: junhaoliao Repo: y-scope/clp PR: 1466 File: .github/workflows/clp-rust-checks.yaml:14-15 Timestamp: 2025-10-22T21:14:12.225Z Learning: Repository y-scope/clp: In GitHub Actions workflows (e.g., .github/workflows/clp-rust-checks.yaml), YAML anchors/aliases are acceptable and preferred to avoid duplication; if actionlint flags an alias node (e.g., on push.paths) as an error, treat it as a tool limitation and do not require inlining unless the team asks to silence the warning.

Learnt from: junhaoliao Repo: y-scope/clp PR: 0 File: :0-0 Timestamp: 2025-10-22T21:02:31.113Z Learning: Repository y-scope/clp: Maintain deterministic CI/builds for Rust; add a check to verify Cargo.lock is in sync with Cargo.toml without updating dependencies (non-mutating verification in clp-rust-checks workflow).

Learnt from: junhaoliao Repo: y-scope/clp PR: 1405 File: components/clp-package-utils/pyproject.toml:5-15 Timestamp: 2025-10-13T03:24:35.074Z Learning: In the y-scope/clp repository, the Python 3.9 to 3.10 version requirement change was intentionally deferred to a separate PR (after PR `#1405`) to reduce review effort, as decided in an offline discussion between junhaoliao and kirkrodrigues.

junhaoliao

shall we update this one too?

clp/docs/src/user-docs/guides-using-presto.md

Line 90 in 3e4c192

git clone https://github.com/y-scope/clp.git

otherwise, the PR is good to go

junhaoliao · 2026-01-19T14:05:35Z

the current title doesn't fully reflect the change in the doc link (though i agree technically it's still dealing with the git branch reference). would this title be more clear and accurate?

fix(docs): Avoid specific hardcoded main branch with `DOCS_VAR_CLP_GIT_REF` in k8s deployment guide.

kirkrodrigues · 2026-01-19T14:49:50Z

fix(docs): Avoid specific hardcoded main branch with `DOCS_VAR_CLP_GIT_REF` in k8s deployment guide.

How about the new title?

…CLP_GIT_REF`. (y-scope#1885)

fix(docs): Replace specific git references with DOCS_VAR_CLP_GIT_REF.

6237df7

kirkrodrigues requested a review from a team as a code owner January 19, 2026 11:56

coderabbitai Bot reviewed Jan 19, 2026

View reviewed changes

kirkrodrigues requested a review from junhaoliao January 19, 2026 12:06

junhaoliao previously approved these changes Jan 19, 2026

View reviewed changes

junhaoliao mentioned this pull request Jan 19, 2026

chore: Bump version for 0.8.0 release and remove edit page button from docs. #1884

Merged

3 tasks

Apply suggestion from code review.

c1d5710

kirkrodrigues dismissed junhaoliao’s stale review via c1d5710 January 19, 2026 14:48

kirkrodrigues changed the title ~~fix(docs): Replace specific git references with DOCS_VAR_CLP_GIT_REF.~~ fix(docs): Replace hardcoded main-branch references with DOCS_VAR_CLP_GIT_REF. Jan 19, 2026

kirkrodrigues requested a review from junhaoliao January 19, 2026 14:49

junhaoliao approved these changes Jan 19, 2026

View reviewed changes

kirkrodrigues merged commit 1459d66 into y-scope:main Jan 19, 2026
10 checks passed

kirkrodrigues deleted the make-links-version-agnostic branch January 19, 2026 15:46

junhaoliao pushed a commit to junhaoliao/clp that referenced this pull request May 17, 2026

fix(docs): Replace hardcoded main-branch references with `DOCS_VAR_…

3fc0fe0

…CLP_GIT_REF`. (y-scope#1885)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(docs): Replace hardcoded `main`-branch references with `DOCS_VAR_CLP_GIT_REF`.#1885

fix(docs): Replace hardcoded `main`-branch references with `DOCS_VAR_CLP_GIT_REF`.#1885
kirkrodrigues merged 2 commits into
y-scope:mainfrom
kirkrodrigues:make-links-version-agnostic

kirkrodrigues commented Jan 19, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jan 19, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot Jan 19, 2026 •

edited

Loading

Uh oh!

kirkrodrigues Jan 19, 2026

Uh oh!

coderabbitai Bot Jan 19, 2026

Uh oh!

junhaoliao left a comment

Uh oh!

junhaoliao commented Jan 19, 2026

Uh oh!

kirkrodrigues commented Jan 19, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

kirkrodrigues commented Jan 19, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Validation performed

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kirkrodrigues Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

junhaoliao left a comment

Choose a reason for hiding this comment

Uh oh!

junhaoliao commented Jan 19, 2026

Uh oh!

kirkrodrigues commented Jan 19, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kirkrodrigues commented Jan 19, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jan 19, 2026 •

edited

Loading

coderabbitai Bot Jan 19, 2026 •

edited

Loading