Skip to content

Add container name on docker tutorial#33303

Open
sarafonseca-123 wants to merge 1 commit into
taosdata:3.0from
sarafonseca-123:docs/name-docker-cont
Open

Add container name on docker tutorial#33303
sarafonseca-123 wants to merge 1 commit into
taosdata:3.0from
sarafonseca-123:docs/name-docker-cont

Conversation

@sarafonseca-123

@sarafonseca-123 sarafonseca-123 commented Oct 18, 2025

Copy link
Copy Markdown

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.

  • Is the user manual updated?
  • Are the test cases passed and automated?
  • Is there no significant decrease in test coverage?

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @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

  • Container Naming: The Docker tutorial commands now explicitly assign the name tdengine to the created container, improving clarity and ease of reference for subsequent commands.
  • Container Teardown Instructions: New instructions have been added to the English Docker tutorial, guiding users on how to properly stop and remove the TDengine container and its associated volumes after use.
  • Command Consistency: The docker exec commands in both English and Chinese documentation have been updated to use the newly assigned container name tdengine, ensuring consistency throughout the tutorial.
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.

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

Comment thread docs/en/04-get-started/01-docker.md Outdated
Comment thread docs/zh/04-get-started/_03-docker.md
@mesquita

Copy link
Copy Markdown

Nice!

@CLAassistant

CLAassistant commented Oct 28, 2025

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.


```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

@feici02 feici02 Dec 1, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Break command into multiple lines for readability
  2. 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

@feici02 feici02 Dec 1, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

@feici02 feici02 Dec 1, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 feici02 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sarafonseca-123 Thanks for your contribution, please check my suggestions above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants