Skip to content

[chore] Update docker/README.md documentation and fix links#18875

Open
zhengkezhou1 wants to merge 2 commits intoapache:mainfrom
zhengkezhou1:update-ci-docker-doc
Open

[chore] Update docker/README.md documentation and fix links#18875
zhengkezhou1 wants to merge 2 commits intoapache:mainfrom
zhengkezhou1:update-ci-docker-doc

Conversation

@zhengkezhou1
Copy link

Summary

  • Fix Markdown link syntax for build.sh.
  • Correct docker/bash.sh usage examples to use proper image names and shortcuts.

@gemini-code-assist
Copy link
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 focuses on improving the accuracy and readability of the Docker documentation. It addresses incorrect Markdown link formatting and updates command examples to ensure users can correctly interact with Docker images using the provided scripts.

Highlights

  • Documentation Update: Fixed Markdown link syntax for the build.sh script in docker/README.md.
  • Usage Example Correction: Corrected docker/bash.sh usage examples to accurately reflect proper image names and shortcuts.

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

Changelog
  • docker/README.md
    • Fixed Markdown link syntax for build.sh.
    • Updated docker/bash.sh usage examples to use Dockerfile.ci_cpu and ci_cpu for clarity and correctness.
    • Adjusted backtick formatting for Dockerfile references.
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.

Copy link
Contributor

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

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 fixes a broken markdown link and updates command examples in the Docker README. The changes are mostly correct, but I've found a couple of issues with the updated examples. One of the example commands uses an incorrect argument, and there's a minor formatting inconsistency in another part of the documentation. I've left specific suggestions to address these points.

Note: Security Review has been skipped due to the limited scope of the PR.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant