Skip to content

docs: update CLI docs to note vcctl is not in release packages#526

Open
atul-upadhyay-7 wants to merge 1 commit into
volcano-sh:masterfrom
atul-upadhyay-7:docs/fix-vcctl-cli-documentation
Open

docs: update CLI docs to note vcctl is not in release packages#526
atul-upadhyay-7 wants to merge 1 commit into
volcano-sh:masterfrom
atul-upadhyay-7:docs/fix-vcctl-cli-documentation

Conversation

@atul-upadhyay-7

Copy link
Copy Markdown
  • Please check if the PR fulfills these requirements
  • The commit message follows our guidelines
  • 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 vcctl is not included
    in official Volcano release packages and must be built from source.

Also fixes several Markdown formatting issues:

  • Added missing code fences around bare command examples
  • Fixed wrong language tag (htmlbash)
  • Added proper installation prerequisites (Go, Git)
  • Added complete build-from-source workflow
  • Fixed abrupt file ending

@volcano-sh-bot volcano-sh-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Jun 7, 2026
@volcano-sh-bot

Copy link
Copy Markdown
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign k82cn for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@volcano-sh-bot

Copy link
Copy Markdown
Collaborator

Welcome @atul-upadhyay-7! It looks like this is your first PR to volcano-sh/website 🎉

@volcano-sh-bot volcano-sh-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jun 7, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Comment thread docs/CLI/Commandline.md
Comment thread docs/CLI/Commandline.md Outdated
@volcano-sh-bot volcano-sh-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Jun 7, 2026
@atul-upadhyay-7 atul-upadhyay-7 force-pushed the docs/fix-vcctl-cli-documentation branch 2 times, most recently from 25f9780 to 8195b6c Compare June 7, 2026 06:55
Comment thread docs/CLI/Commandline.md Outdated
Fixes volcano-sh#123

Signed-off-by: atul-upadhyay-7 <atul-upadhyay-7@users.noreply.github.com>
@atul-upadhyay-7 atul-upadhyay-7 force-pushed the docs/fix-vcctl-cli-documentation branch from 8195b6c to edebabf Compare June 9, 2026 18:47
@atul-upadhyay-7

atul-upadhyay-7 commented Jun 9, 2026

Copy link
Copy Markdown
Author

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!

@atul-upadhyay-7

Copy link
Copy Markdown
Author

@JesseStutler @Arhell @william-wang could you review this pr

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/documentation Categorizes issue or PR as related to documentation. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

there is no vcctl in release packages.

3 participants