Cloud: Import ux optimization (#21361) #21448
Conversation
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Grace Cai <qqzczy@126.com>
ti-chi-bot
added
area/tidb-cloud
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @ti-chi-bot, 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 updates the documentation for the TiDB Cloud data import feature to reflect recent user experience optimizations. The changes detail a more streamlined workflow for importing data from various cloud storage providers (Amazon S3, Google Cloud Storage, Azure Blob Storage, Alibaba Cloud OSS) for CSV, Parquet, and sample data, focusing on a unified import page and improved destination mapping capabilities.
Highlights
- Updated Import Workflow: The documentation for the data import feature has been revised to reflect a streamlined user interface. The selection of the cloud storage provider (Amazon S3, Google Cloud Storage, Azure Blob Storage, Alibaba Cloud OSS) now occurs on a unified 'Import Data from Cloud Storage' page, rather than as a separate initial click.
- Enhanced Destination Mapping Guidance: The instructions for mapping source files to target tables have been significantly expanded and clarified. This includes detailed explanations for automatic mapping based on file naming conventions and comprehensive guidance for manual mapping, now supporting wildcards (
*and?). - Revised Step-by-Step Instructions: The entire data import process, including credential configuration, source file URI specification, and the progression through the UI (e.g., 'Connect' changed to 'Next', and the introduction of a 'Review scan results' step), has been updated to align with the new user experience.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 or fill out our survey to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for the TiDB Cloud data import feature to reflect a new, more streamlined user interface. The changes are applied consistently across the guides for importing CSV, Parquet, and sample data from various cloud storage providers.
Overall, the new instructions are clearer and provide a more detailed, step-by-step guide for users. I've identified a few minor areas for improvement related to grammar, consistency, and clarity, and have provided suggestions to address them.
I've reviewed the changes based on the provided Documentation Review Style Guide. My feedback focuses on:
- Clarity and Readability (Style Guide lines 14, 21): Ensuring instructions are easy to follow.
- Correctness (Style Guide line 20): Fixing punctuation.
- Consistency (Style Guide lines 16, 25, 30): Aligning terminology and formatting across documents.
- Conciseness (Style Guide line 24): Removing repetitive content.
I've included references to the specific style guide rules in my comments where applicable.
|
|
||
| 7. Review the scan results, check the data files found and corresponding target tables, and then click **Start Import**. | ||
|
|
||
| 8. When the import progress shows **Completed**, check the imported tables. | ||
|
|
||
| When the data import progress shows **Completed**, you have successfully imported the sample data and the database schema to your database in TiDB Cloud Starter. |
There was a problem hiding this comment.
This sentence is redundant because step 8 already instructs the user on what to do when the import is complete. Removing this line will make the document more concise and consistent with the other updated import documents in this PR.1
Style Guide References
Footnotes
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiancai The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
This is an automated cherry-pick of #21361
First-time contributors' checklist
What is changed, added or deleted? (Required)
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?