[WIP] cloud: update steps according to the new nav pane #21130
Conversation
ti-chi-bot
bot
added
missing-translation-status
qiancai
added
translation/no-need
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hello @qiancai, 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!
Summary of Changes
Hello team,
Gemini here, providing a summary of this pull request. This PR primarily focuses on updating the documentation for the TiDB Cloud console navigation. It reflects changes in the UI where several pages (like Backup, Import, Changefeed, Metrics, Events, Networking, SQL Users, DB Audit Logging, Encryption Access, Maintenance, Network Access, Integrations, Recovery Group, and Data Migration) are now nested under new top-level navigation items, specifically "Data", "Monitoring", and "Settings", or accessed directly from the project settings.
The changes involve adding new introductory sections explaining how to access these pages from the Clusters overview page and updating existing navigation steps throughout the affected documents to point to these new paths and sections. This ensures the documentation accurately guides users through the latest console interface.
Highlights
- Documentation Updates: Updates documentation across numerous files to reflect changes in the TiDB Cloud console navigation structure.
- Navigation Paths: Introduces new navigation paths under 'Data', 'Monitoring', and 'Settings' for various features like Backup, Import, Changefeed, Metrics, Events, Networking, SQL Users, and DB Audit Logging.
- Project Settings Navigation: Updates navigation paths for project-level settings like Encryption Access, Maintenance, Network Access, Integrations, and Recovery Group.
- Consistent Entry Points: Standardizes the starting point for many navigation instructions to be the 'Clusters' overview page.
Changelog
Click here to see the changelog
- tidb-cloud/backup-and-restore-serverless.md
- Added 'View the Backup page' section.
- Updated navigation steps to use 'Data > Backup' and link to the new section.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/backup-and-restore.md
- Added 'View the Backup page' section.
- Updated navigation steps to use 'Data > Backup' and link to the new section.
- Updated navigation for restoring from Recycle Bin.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/built-in-monitoring.md
- Updated navigation to the Metrics page to use 'Monitoring > Metrics'.
- Updated references to the 'Metrics' page to be bolded.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/changefeed-overview.md
- Added 'View the Changefeed page' section.
- Updated navigation steps to use 'Data > Changefeed' and link to the new section.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/changefeed-sink-to-apache-kafka.md
- Updated navigation to the Changefeed page to use 'Data > Changefeed'.
- tidb-cloud/changefeed-sink-to-apache-pulsar.md
- Updated navigation to the Changefeed page to use 'Data > Changefeed'.
- tidb-cloud/changefeed-sink-to-cloud-storage.md
- Updated navigation to the Changefeed page to use 'Data > Changefeed'.
- tidb-cloud/changefeed-sink-to-mysql.md
- Updated navigation to the Changefeed page to use 'Data > Changefeed'.
- tidb-cloud/changefeed-sink-to-tidb-cloud.md
- Updated navigation to the Changefeed page to use 'Data > Changefeed'.
- tidb-cloud/configure-ip-access-list.md
- Updated navigation to the Networking page to use 'Settings > Networking'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/configure-maintenance-window.md
- Updated navigation to the Maintenance page to use 'Project Settings > Maintenance'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/configure-security-settings.md
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/configure-serverless-firewall-rules-for-public-endpoints.md
- Updated navigation to the Networking page to use 'Settings > Networking'.
- Updated references to 'Firewall Rules' to 'Authorized Networks'.
- tidb-cloud/configure-sql-users.md
- Added 'View SQL users' section.
- Updated navigation steps for creating, editing, and deleting users to use 'Settings > SQL Users' and link to the new section.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/connect-via-sql-shell.md
- Updated navigation to the Networking page to use 'Settings > Networking'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/connect-via-standard-connection-serverless.md
- Updated navigation to the Networking page to use 'Settings > Networking'.
- tidb-cloud/connect-via-standard-connection.md
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/create-tidb-cluster.md
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/dedicated-external-storage.md
- Updated navigation to the Import page to use 'Data > Import'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/dev-guide-bi-looker-studio.md
- Updated navigation to the Import page to use 'Data > Import'.
- tidb-cloud/explore-data-with-chat2query.md
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/import-csv-files-serverless.md
- Updated navigation to the Import page to use 'Data > Import'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/import-csv-files.md
- Updated navigation to the Import page to use 'Data > Import'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/import-parquet-files-serverless.md
- Updated navigation to the Import page to use 'Data > Import'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/import-parquet-files.md
- Updated navigation to the Import page to use 'Data > Import'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/import-sample-data-serverless.md
- Updated navigation to the Import page to use 'Data > Import'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/import-sample-data.md
- Updated navigation to the Import page to use 'Data > Import'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/import-with-mysql-cli.md
- Updated navigation to the Networking page to use 'Settings > Networking'.
- tidb-cloud/index-insight.md
- Updated navigation to the Diagnosis page to link to the new 'View' section in
tune-performance.md.
- Updated navigation to the Diagnosis page to link to the new 'View' section in
- tidb-cloud/manage-serverless-spend-limit.md
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/manage-user-access.md
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/migrate-from-mysql-using-data-migration.md
- Updated navigation to the Data Migration page to use 'Data > Migration'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/migrate-from-op-tidb.md
- Updated navigation for granting TiCDC access and getting connection info to use the new 'Settings > Networking' path.
- tidb-cloud/migrate-incremental-data-from-mysql-using-data-migration.md
- Updated navigation to the Data Migration page to use 'Data > Migration'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/migrate-sql-shards.md
- Updated navigation to the Import page to use 'Data > Import'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/monitor-alert-email.md
- Updated navigation to the Alert Subscription page to use 'Project Settings > Alert Subscription'.
- Updated link to the Alert page.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/monitor-alert-slack.md
- Updated navigation to the Alert Subscription page to use 'Project Settings > Alert Subscription'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/monitor-alert-zoom.md
- Updated navigation to the Alert Subscription page to use 'Project Settings > Alert Subscription'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/monitor-built-in-alerting.md
- Updated references to the Alerts page to be bolded.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/monitor-datadog-integration.md
- Updated navigation to the Integrations page to use 'Project Settings > Integrations'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/monitor-new-relic-integration.md
- Updated navigation to the Integrations page to use 'Project Settings > Integrations'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/monitor-prometheus-and-grafana-integration.md
- Updated navigation to the Integrations page to use 'Project Settings > Integrations'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/monitor-tidb-cluster.md
- Updated references to Overview and Metrics pages to be bolded.
- Updated navigation to the Overview and Metrics pages.
- Updated link for Built-in Monitoring.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/monitoring-concepts.md
- Updated reference to the Metrics page to be bolded.
- tidb-cloud/recovery-group-delete.md
- Updated navigation to the Recovery Group page to use 'Recovery Group' directly from the left nav.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/recovery-group-failover.md
- Updated navigation to the Recovery Group page to use 'Recovery Group' directly from the left nav.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/recovery-group-get-started.md
- Updated navigation to the Recovery Group page to use 'Project Settings > Recovery Group'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/serverless-export.md
- Updated navigation to the Import page to use 'Data > Import'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/serverless-external-storage.md
- Updated navigation to the Import page to use 'Data > Import'.
- tidb-cloud/serverless-faqs.md
- Updated navigation to the Diagnosis page to link to the new 'View' section in
tune-performance.md.
- Updated navigation to the Diagnosis page to link to the new 'View' section in
- tidb-cloud/set-up-private-endpoint-connections-on-azure.md
- Updated navigation to the Networking page to use 'Settings > Networking'.
- tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md
- Updated navigation to the Networking page to use 'Settings > Networking'.
- tidb-cloud/set-up-private-endpoint-connections.md
- Updated navigation to the Networking page to use 'Settings > Networking'.
- Updated navigation to the Project-level Network Access page to use 'Project Settings > Network Access'.
- tidb-cloud/set-up-vpc-peering-connections.md
- Updated navigation to the Network Access page to use 'Project Settings > Network Access'.
- Updated navigation to the cluster-level Networking page to use 'Settings > Networking'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/setup-aws-self-hosted-kafka-private-link-service.md
- Updated navigation to the Changefeed page to use 'Data > Changefeed'.
- Updated navigation to the Project CIDR page to use 'Project Settings > Network Access > Project CIDR'.
- tidb-cloud/setup-azure-self-hosted-kafka-private-link-service.md
- Updated navigation to the Changefeed page to use 'Data > Changefeed'.
- tidb-cloud/setup-self-hosted-kafka-private-service-connect.md
- Updated navigation to the Changefeed page to use 'Data > Changefeed'.
- tidb-cloud/third-party-monitoring-integrations.md
- Updated navigation to the Integrations page to use 'Project Settings > Integrations'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/tidb-cloud-auditing.md
- Updated navigation to the DB Audit Logging page to use 'Settings > DB Audit Logging'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/tidb-cloud-encrypt-cmek.md
- Updated navigation to the Encryption Access page to use 'Project Settings > Encryption Access'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/tidb-cloud-events.md
- Updated references to the Events page to be bolded.
- Updated navigation to the Events page to use 'Monitoring > Events'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/tidb-cloud-import-local-files.md
- Updated navigation to the Import page to use 'Data > Import'.
- Updated tip about switching between organizations/projects/clusters.
- tidb-cloud/tidb-cloud-poc.md
- Updated navigation to Diagnosis tabs (Statements, Key Visualizer) to link to the new 'View' section in
tune-performance.md. - Updated navigation to the Metrics page to link to the new 'View' section in
built-in-monitoring.md.
- Updated navigation to Diagnosis tabs (Statements, Key Visualizer) to link to the new 'View' section in
- tidb-cloud/tidb-cloud-sql-tuning-overview.md
- Updated references to the SQL Statement and Diagnosis pages to link to the new 'View' section in
tune-performance.md.
- Updated references to the SQL Statement and Diagnosis pages to link to the new 'View' section in
- tidb-cloud/tidb-cloud-tune-performance-overview.md
- Updated references to Diagnosis and Metrics pages to link to the new 'View' sections in
tune-performance.mdandbuilt-in-monitoring.md.
- Updated references to Diagnosis and Metrics pages to link to the new 'View' sections in
- tidb-cloud/tidb-node-group-management.md
- Updated navigation to the Networking page to use 'Settings > Networking'.
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 is currently in preview and 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 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. ↩
qiancai
changed the title
ti-chi-bot
bot
added
do-not-merge/work-in-progress
There was a problem hiding this comment.
Code Review
The changes in this pull request update the navigation instructions across several documentation files to reflect recent UI changes in the TiDB Cloud console. The updates are generally consistent and improve the clarity and maintainability of the documentation by introducing dedicated sections for viewing specific pages and linking to them from various task steps. The change to use the drop-down box for switching projects is also a good simplification.
I've identified one minor typo that should be addressed before merging. Otherwise, the changes look good.
Summary of Findings
- Navigation Updates: The pull request consistently updates navigation paths in the documentation to align with the current TiDB Cloud console UI, grouping items under 'Data', 'Settings', or 'Monitoring'. This improves accuracy and user experience.
- Modular Navigation Steps: New sections describing how to navigate to specific pages (like Backup, Diagnosis, Changefeed, SQL Users) have been added. Existing steps now link to these sections, making the documentation more modular and easier to maintain and reference.
- Consistent Phrasing: The phrasing for switching between projects using the drop-down box has been standardized across multiple files, improving consistency.
- Minor Typo: A small typo (
****) was found after the wordChangefeedin one file (tidb-cloud/changefeed-sink-to-cloud-storage.md). This is a low-severity issue.
Merge Readiness
The pull request introduces necessary updates to navigation instructions across the documentation. The changes are well-structured and consistent, improving the overall quality. There is one minor typo that should be corrected. I recommend addressing this low-severity issue before merging. Please have other reviewers approve this code before merging, as I am unable to directly approve the pull request.
|
@gemini-code-assist[bot]: adding LGTM is restricted to approvers and reviewers in OWNERS files. In response to this:
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-sigs/prow repository. |
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
[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 |
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?