-
Notifications
You must be signed in to change notification settings - Fork 5k
docs: automatically detect version for codeblocks #34460
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: 3.3.6
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @danielclow, 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 significantly enhances the maintainability and accuracy of the documentation by implementing an automated version detection mechanism for code examples. By replacing static version numbers with a dynamic placeholder and adding specific language tags to code blocks, the changes ensure that installation and usage instructions always reflect the current software version without requiring manual updates, thereby improving the user experience and reducing documentation overhead. Highlights
🧠 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 AssistThe 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
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 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
|
There was a problem hiding this 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 updates documentation to automatically detect and insert version numbers in code blocks, which is a great improvement for maintainability. The changes are mostly consistent and well-implemented. I've pointed out a few places where the documentation could be clearer or more consistent to avoid user confusion, particularly regarding Docker image versions in run commands and a removed piece of information about package naming.
| This section describes how to install TDengine Enterprise on a bare metal machine. Note that the same instructions also apply to virtual machines. | ||
|
|
||
| 1. Transfer the installation package for TDengine Enterprise to the target machine. The installation package is provided along with the delivery of your TDengine Enterprise license. The package name is in the format `TDengine-enterprise-<version>-Linux-<arch>.tar.gz`. | ||
| 1. Transfer the installation package for TDengine Enterprise to the target machine. The installation package is provided along with the delivery of your TDengine Enterprise license. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While the command in the next step shows the package name format, explicitly mentioning it in the description is clearer for the user. Consider adding the package name format back, using the new {{VERSION}} placeholder for consistency.
| 1. Transfer the installation package for TDengine Enterprise to the target machine. The installation package is provided along with the delivery of your TDengine Enterprise license. | |
| 1. Transfer the installation package for TDengine Enterprise to the target machine. The installation package is provided along with the delivery of your TDengine Enterprise license. The package name is in the format `TDengine-enterprise-{{VERSION}}-Linux-<arch>.tar.gz`. |
|
|
||
| ```shell | ||
| docker run -d -p 6090:6090 -p 5000:5000 tdengine/tdengine-tdgpt:3.3.6.0 | ||
| docker run -d -p 6090:6090 -p 5000:5000 tdengine/tdengine-tdgpt |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The docker run command uses the latest tag by default, which might be confusing for users who have just pulled a specific version using {{VERSION}}. This command will not use the version they just pulled. To ensure the user runs the version they intended, consider updating this command to use {{VERSION}} and also adding tdgpt to the code block's language specifier (e.g., ```shell tdgpt).
|
|
||
| ```shell | ||
| docker run -d -p 6090:6090 -p 5000:5000 -p 5001:5001 tdengine/tdengine-tdgpt-full:3.3.6.0 | ||
| docker run -d -p 6090:6090 -p 5000:5000 -p 5001:5001 tdengine/tdengine-tdgpt-full |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similar to the standard image, the docker run command for the full image uses the latest tag, while the user might have just pulled a specific version. This can be confusing. Consider updating this command to use {{VERSION}} and adding tdgpt to the code block's language specifier to ensure the user runs the version they intended to.
use auto version detection in codeblocks