add vcctl missing docs

[FAUST-BENCHOU]

• Please check if the PR fulfills these requirements

• The commit message follows our guidelines

• What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

• What this PR does / why we need it:

• Which issue(s) this PR fixes:
  Close vcctl docs missing #434

[volcano-sh-bot]

[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 jessestutler 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:

• OWNERS

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]

Welcome @FAUST-BENCHOU! It looks like this is your first PR to volcano-sh/website 🎉

[gemini-code-assist]

Summary of Changes

Hello @FAUST-BENCHOU, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses missing documentation for the vcctl command-line tool by adding comprehensive guides for various commands. The update aims to provide users with a more complete and organized reference for managing resources, covering operations related to Jobs, Queues, JobFlows, JobTemplates, Pods, and version information. This enhancement significantly improves the usability and accessibility of the vcctl tool's documentation.

Highlights

• Expanded vcctl Documentation: The documentation for the vcctl command-line interface has been significantly expanded to cover a wider range of functionalities.
• New Command Sections: Dedicated sections have been added for Queue Commands, JobFlow Commands, JobTemplate Commands, Pod Commands, and Version Command, providing detailed usage and examples.
• Enhanced Job Commands: The existing Job Commands section has been restructured and now includes documentation for the vcctl job view command.
• Code Block Syntax Update: All command examples within the documentation have been updated to use shell syntax highlighting instead of html for improved readability and accuracy.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[FAUST-BENCHOU]

@JesseStutler @hzxuzhonghu ptal.

[gemini-code-assist]

Code Review

This pull request significantly improves the vcctl CLI documentation by adding many missing commands and restructuring the content for better clarity. The updates in both English and Chinese versions are valuable, especially the corrections to command examples and the consistent use of shell for code blocks. I've added a couple of suggestions to further enhance the documentation's consistency and readability. One suggestion is about improving the format for listing valid actions, and the other is about a potential inconsistency in the vcctl jobtemplate list command's flags compared to other similar commands.

[gemini-code-assist]

For better readability, consider presenting the valid actions as a bulleted list.

Suggested change

	Valid actions: `open`, `close`, `update`
	Valid actions:
	* `open`
	* `close`
	* `update`

[gemini-code-assist]

For consistency with other list commands like vcctl job list and vcctl jobflow list, consider adding the --all-namespaces flag here. Other jobtemplate commands support the --namespace flag, which implies they are namespaced resources.

Suggested change

	vcctl jobtemplate list [--namespace namespace]
	vcctl jobtemplate list [--namespace namespace] [--all-namespaces]

[gemini-code-assist]

For better readability, consider presenting the valid actions as a bulleted list. This is a parallel suggestion to the one for the English documentation.

Suggested change

	有效操作：`open`, `close`, `update`
	有效操作：
	* `open`
	* `close`
	* `update`

[gemini-code-assist]

For consistency with other list commands, consider adding the --all-namespaces flag here, similar to the suggestion for the English documentation. Other jobtemplate commands support the --namespace flag, which implies they are namespaced resources.

Suggested change

	vcctl jobtemplate list [--namespace namespace]
	vcctl jobtemplate list [--namespace namespace] [--all-namespaces]