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

Debug TiDB Cloud Documentation: TiDB Cloud Quick Start #15738

Closed
Tracked by #15480
qiancai opened this issue Dec 16, 2023 · 8 comments · Fixed by #16128
Closed
Tracked by #15480

Debug TiDB Cloud Documentation: TiDB Cloud Quick Start #15738

qiancai opened this issue Dec 16, 2023 · 8 comments · Fixed by #16128
Assignees
Labels
2024-tidb-docs-dash This issue or PR is included in the 2024 TiDB Docs Dash event.

Comments

@qiancai
Copy link
Collaborator

qiancai commented Dec 16, 2023

This issue is a sub-issue of Debug TiDB Cloud Documentation: Summary Issue · Issue #15480 · pingcap/docs. The purpose of this sub-issue is to verify and debug the TiDB Cloud Quick Start document.

You can follow the instructions provided in #15480 to verify and debug the instructions in this document.

  1. After finishing your verification, please add your verification result to this sub-issue as a comment. The result can be the issues you encounter, the mistakes you find, or any other findings. If everything looks fine, you can also add it as a comment.
  2. For any issues you found during the verification, welcome to create a pull request (PR) to fix them directly. In the pull request, please indicate which issue this PR resolves in the PR description (for example, fix #15738). To learn how to create a pull request, see TiDB Documentation Contributing Guide.

Note: Currently, the TiDB Cloud documentation is in English only and it is stored in the release-7.5 branch of pingcap/docs for reusing the SQL documentation of TiDB. Hence, to create a pull request for TiDB Cloud documentation, make sure that your PR is based on the release-7.5 branch.

Your contribution to testing and verifying the documentation is highly appreciated!

@qiancai qiancai added the 2024-tidb-docs-dash This issue or PR is included in the 2024 TiDB Docs Dash event. label Dec 16, 2023
@Jellybeanvino
Copy link

/assign

@rpaik
Copy link
Member

rpaik commented Jan 10, 2024

👋 @Jellybeanvino, just a quick reminder to make your TiDB Docs Dash contributions by January 12 at 07:59 UTC.

Let us know if you have any questions!

@Jellybeanvino
Copy link

👋 @Jellybeanvino, just a quick reminder to make your TiDB Docs Dash contributions by January 12 at 07:59 UTC.

Let us know if you have any questions!
hi, rpaik
I follow the steps in the tutorial you can either simply type -- followed by your instructions to let AI automatically generate SQL queries, but not work. The steps are shown below:

image

Is there anything that I did wrong?

@dveeden
Copy link
Contributor

dveeden commented Jan 11, 2024

@Jellybeanvino For Chat2Query AI queries you need to start the line with -- any thing else is either a comment (starts with #) or a SQL query. Hope this helps.

@dveeden
Copy link
Contributor

dveeden commented Jan 11, 2024

An example:
image

Here I have a table with names and then I entered:
-- Give me one name
and the system created:

SELECT
  `name`
FROM
  `names`
LIMIT
  1;

When I accept the query (and optionally change bits of it) and then execute it I get:
image

@dveeden
Copy link
Contributor

dveeden commented Jan 11, 2024

And it can do INSERT statements:
image

@Jellybeanvino
Copy link

Jellybeanvino commented Jan 11, 2024

@dveeden Thanks for your patient reply. Your example helps me and now I �figure out how to run it. To help other guys like me new to TiDB Cloud or Chat2Query, adding some simple examples after the tutorial would be better.

@qiancai
Copy link
Collaborator Author

qiancai commented Jan 31, 2024

Hi @Jellybeanvino, thanks so much for all your valuable comments and the doc update PR ❤️. As the PR has been merged, I'll close this issue. If you notice any doc issues in the future, feel free to create an issue or PR in the documentation repository.

@qiancai qiancai closed this as completed Jan 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2024-tidb-docs-dash This issue or PR is included in the 2024 TiDB Docs Dash event.
Development

Successfully merging a pull request may close this issue.

4 participants