-
Notifications
You must be signed in to change notification settings - Fork 685
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
TiDB Quick Start refresh #19412
base: master
Are you sure you want to change the base?
TiDB Quick Start refresh #19412
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
@alastori: The following test failed, say
Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
=============================================== | ||
``` | ||
```shell | ||
source ~/.bash_profile |
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.
source ~/.bash_profile
The current description is too specific and may mislead users, as shell profile paths can vary across different Linux distributions and shell types. I recommend keeping the original, more flexible instructions:
Lines 55 to 67 in 063e85c
Note the Shell profile path in the output above. You need to use the path in the next step. | |
2. Declare the global environment variable: | |
> **Note:** | |
> | |
> After the installation, TiUP displays the absolute path of the corresponding Shell profile file. You need to modify `${your_shell_profile}` in the following `source` command according to the path. In this case, `${your_shell_profile}` is `/Users/user/.zshrc` from the output of Step 1. | |
{{< copyable "shell-regular" >}} | |
```shell | |
source ${your_shell_profile} | |
``` |
For example, in the installation output shown below, the shell profile is /home/codespace/.bashrc
:
Successfully set mirror to https://tiup-mirrors.pingcap.com
Detected shell: bash
Shell profile: /home/codespace/.bashrc
/home/codespace/.bashrc has been modified to add tiup to PATH
open a new terminal or source /home/codespace/.bashrc to use it
Installed path: /home/codespace/.tiup/bin/tiup
===============================================
Have a try: tiup playground
===============================================
open a new terminal or source /home/codespace/.bashrc to use it
|
||
{{< copyable "shell-regular" >}} | ||
You should see this output: |
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.
You should see this output: | |
The output is as follows: |
should, should be link
Generally avoid.
Because should is ambiguous by definition, it can be problematic.
"If an outcome is expected: Describe the outcome in terms of what is expected. For example: "The process returns 10 items."
What is changed, added or deleted? (Required)
Significantly improved the Quick Start Guide to make it more user-friendly and educational:
The changes aim to provide a better first-time user experience while maintaining technical accuracy and demonstrating TiDB's key features through practical examples.
Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
This PR updates the existing Quick Start Guide with modern documentation best practices and a more comprehensive learning approach.