Add container name on docker tutorial#33303
Conversation
Summary of ChangesHello @sarafonseca-123, 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 Docker tutorial documentation by standardizing the naming of the TDengine container and providing explicit instructions for its cleanup. These changes aim to make the tutorial more user-friendly and prevent potential confusion or resource accumulation for users following the guide. Highlights
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.
Code Review
This pull request improves the Docker tutorial by adding a container name to the docker run commands and including instructions for stopping and removing the container. These changes make the tutorial easier for users to follow. My review includes a suggestion to add the cleanup instructions to the Chinese documentation to maintain consistency with the English version. I've also proposed a minor simplification for one of the Docker commands for conciseness.
|
Nice! |
4ff280d to
35652f6
Compare
35652f6 to
9b17335
Compare
|
|
||
| ```bash | ||
| docker run -d -p 6030:6030 -p 6041:6041 -p 6043-6060:6043-6060 -p 6043-6060:6043-6060/udp tdengine/tdengine | ||
| docker run --name tdengine -d -p 6030:6030 -p 6041:6041 -p 6043-6060:6043-6060 -p 6043-6060:6043-6060/udp tdengine/tdengine |
There was a problem hiding this comment.
| docker run --name tdengine -d -p 6030:6030 -p 6041:6041 -p 6043-6060:6043-6060 -p 6043-6060:6043-6060/udp tdengine/tdengine | |
| docker run --name tdengine-tsdb -d \ | |
| -p 6030:6030 -p 6041:6041 \ | |
| -p 6043-6060:6043-6060 \ | |
| -p 6043-6060:6043-6060/udp \ | |
| tdengine/tsdb |
There was a problem hiding this comment.
- Break command into multiple lines for readability
- Image name for TDengine has been renamed to tdengine/tsdb.
|
|
||
| ```bash | ||
| docker run -d -v <local-data-directory>:/var/lib/taos -v <local-log-directory>:/var/log/taos -p 6030:6030 -p 6041:6041 -p 6043-6060:6043-6060 -p 6043-6060:6043-6060/udp tdengine/tdengine | ||
| docker run --name tdengine -d -v <local-data-directory>:/var/lib/taos -v <local-log-directory>:/var/log/taos -p 6030:6030 -p 6041:6041 -p 6043-6060:6043-6060 -p 6043-6060:6043-6060/udp tdengine/tdengine |
There was a problem hiding this comment.
| docker run --name tdengine -d -v <local-data-directory>:/var/lib/taos -v <local-log-directory>:/var/log/taos -p 6030:6030 -p 6041:6041 -p 6043-6060:6043-6060 -p 6043-6060:6043-6060/udp tdengine/tdengine | |
| docker run --name tdengine-tsdb -d \ | |
| -v <local-data-directory>:/var/lib/taos \ | |
| -v <local-log-directory>:/var/log/taos \ | |
| -p 6030:6030 -p 6041:6041 \ | |
| -p 6043-6060:6043-6060 \ | |
| -p 6043-6060:6043-6060/udp \ | |
| tdengine/tsdb |
There was a problem hiding this comment.
Actually, this file has not been used any more in the docs. The changes here is not necessary.
This file may be deleted in the future.
feici02
left a comment
There was a problem hiding this comment.
@sarafonseca-123 Thanks for your contribution, please check my suggestions above.
Description
Add a container name on Docker tutorial documentation and instructions on how to tear down the container, to make it easier to follow subsequent instructions.
Checklist
Please check the items in the checklist if applicable.