Skip to content

[Docs] Add basic gcluster job submit guide to README and incorporate PR #5492 edits#5981

Draft
SwarnaBharathiMantena wants to merge 8 commits into
GoogleCloudPlatform:developfrom
SwarnaBharathiMantena:swarnabm/job-submit-docs
Draft

[Docs] Add basic gcluster job submit guide to README and incorporate PR #5492 edits#5981
SwarnaBharathiMantena wants to merge 8 commits into
GoogleCloudPlatform:developfrom
SwarnaBharathiMantena:swarnabm/job-submit-docs

Conversation

@SwarnaBharathiMantena

Copy link
Copy Markdown
Contributor

Summary

This PR updates README.md to introduce high-level customer-facing documentation for gcluster job submit and incorporates technical writing review edits from PR #5492.

Key Changes

  1. gcluster job submit Overview & Quickstart:
    • Added a minimal ## Job Submission (gcluster job submit) section to README.md.
    • Documented prerequisites (GCLUSTER_IMAGE_REPO, kubectl, GKE auth plugin).
    • Added example usage for pre-built images and on-the-fly image builds (--build-context).
    • Included persistent CLI configuration setting examples (gcluster job config set).
    • Linked to the detailed Gcluster Job Submission Guide for advanced topics (storage mounts, Kueue priority queues, multi-slice topologies).
  2. Technical Writing Cleanups (PR Restructure and edit information on README.md #5492):
    • Streamlined product overview and main component breakdown.
    • Updated pre-built bundle execution platform compatibility matrix and download steps.
    • Formatted all raw text URLs into clean, relative Markdown links.
    • Preserved .tgz tarball bundle release steps from upstream/develop.

Testing & Validation

  • Verified Markdown formatting and relative documentation links.
  • Confirmed alignment with existing CLI flags and technical documentation guidelines.

@SwarnaBharathiMantena SwarnaBharathiMantena self-assigned this Jul 21, 2026
@SwarnaBharathiMantena SwarnaBharathiMantena added the release-improvements Added to release notes under the "Improvements" heading. label Jul 21, 2026
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! 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 enhances the project's primary documentation by introducing a dedicated section for the 'gcluster job submit' command and incorporating various technical writing refinements. These changes aim to provide users with a clearer, more accessible quickstart experience while ensuring the documentation remains aligned with current best practices.

Highlights

  • Documentation Update: Added a comprehensive guide for 'gcluster job submit' to the README, covering prerequisites, pre-built image usage, on-the-fly image building, and configuration defaults.
  • Technical Writing Improvements: Streamlined the product overview, updated the bundle compatibility matrix, and converted raw text URLs into clean, relative Markdown links to improve readability and maintenance.
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 the 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 counterproductive. 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.

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.

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

Copy link
Copy Markdown
Contributor

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 significantly refactors and updates the README.md file to improve clarity, streamline installation instructions, and document the new gcluster job submit command. Feedback is provided to correct a grammatical issue where the noun "setup" was used instead of the verb phrase "set up".

Comment thread README.md Outdated
@SwarnaBharathiMantena

Copy link
Copy Markdown
Contributor Author

/gemini review

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

Copy link
Copy Markdown
Contributor

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 README.md to simplify the project description and introduces a comprehensive section on the gcluster job submit command, detailing prerequisites, job submission examples, and job management. The review feedback suggests clarifying that GCLUSTER_IMAGE_REPO requires the full Artifact Registry repository path to prevent push failures, and recommends replacing an absolute GitHub URL with a relative link for internal repository references.

Comment thread README.md Outdated
Comment thread README.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

release-improvements Added to release notes under the "Improvements" heading.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants