docs: update CLI docs to note vcctl is not in release packages#526
docs: update CLI docs to note vcctl is not in release packages#526atul-upadhyay-7 wants to merge 1 commit into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Welcome @atul-upadhyay-7! It looks like this is your first PR to volcano-sh/website 🎉 |
There was a problem hiding this comment.
Code Review
This pull request updates the CLI documentation for vcctl in docs/CLI/Commandline.md by adding installation prerequisites, build-from-source instructions, and formatting the command-line reference examples. The review feedback highlights an incorrect command structure in one of the examples (vcctl delete job instead of vcctl job delete) and suggests updating the corresponding Chinese translation file to keep the documentation synchronized.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
25f9780 to
8195b6c
Compare
Fixes volcano-sh#123 Signed-off-by: atul-upadhyay-7 <atul-upadhyay-7@users.noreply.github.com>
8195b6c to
edebabf
Compare
|
Hey @JesseStutler thanks for the review! I've updated the PR — removed the "not included in release packages" note from both the English and Chinese docs since #5384 is already tracking vcctl inclusion in the release artifacts. The PR now just focuses on fixing the markdown formatting issues (missing code fences, wrong language tags, incorrect command order) and adding proper build-from-source steps. Let me know if anything else needs updating! |
|
@JesseStutler @Arhell @william-wang could you review this pr |
What kind of change does this PR introduce?
/kind documentation
What this PR does / why we need it:
Updates the CLI documentation to clearly state that
vcctlis not includedin official Volcano release packages and must be built from source.
Also fixes several Markdown formatting issues:
html→bash)Fixes there is no vcctl in release packages. #123