Skip to content
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

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

alastori
Copy link
Contributor

What is changed, added or deleted? (Required)

Significantly improved the Quick Start Guide to make it more user-friendly and educational:

  • Restructured content to follow a clear learning path
  • Added a sample weather monitoring application to demonstrate real-world usage
  • Improved monitoring and scaling sections with practical examples
  • Added detailed explanations of components and their roles
  • Included developer workflow best practices with tagged environments
  • Enhanced the guide with monitoring visualization tips
  • Added clear "What's next" section with targeted resources
  • Improved code examples with proper formatting and explanations
  • Added more contextual information about TiDB's capabilities
  • Improved navigation and readability

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)

  • master (the latest development version)

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.

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Nov 15, 2024
@lilin90 lilin90 self-assigned this Nov 15, 2024
Copy link

ti-chi-bot bot commented Nov 15, 2024

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from lilin90, ensuring that each of them provides their approval before proceeding. For more information see the Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@lilin90 lilin90 requested a review from likidu November 15, 2024 02:47
@ti-chi-bot ti-chi-bot bot added the area/develop This PR relates to the area of TiDB App development. label Nov 15, 2024
@lilin90 lilin90 added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 15, 2024
Copy link

ti-chi-bot bot commented Nov 19, 2024

@alastori: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-verify 690e280 link true /test pull-verify

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
Copy link
Collaborator

@Oreoxmt Oreoxmt Nov 22, 2024

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:

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:
Copy link
Collaborator

Choose a reason for hiding this comment

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

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

https://developers.google.com/style/word-list#should

github-actions bot pushed a commit to Oreoxmt/pingcap-docsite-preview that referenced this pull request Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/develop This PR relates to the area of TiDB App development. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants