Skip to content

Conversation

@BohuTANG
Copy link
Member

@BohuTANG BohuTANG commented Nov 24, 2025

Description

This PR significantly refactors the Chinese tutorial section to improve clarity, consistency, and user experience. It standardizes titles, sidebar labels, and category names to follow a clear "Action + Tool/Object" pattern.

Key Changes

1. Category Restructuring

Renamed categories to be concise noun phrases for better navigation:

  • Getting Started -> 客户端连接 (Client Connectivity)
  • Ingest -> 数据接入 (Data Ingestion)
  • Cloud Ops -> 云端运维 (Cloud Operations)
  • Ops -> 备份与恢复 (Backup & Recovery)

2. Title & Sidebar Standardization

Adopted a unified "Action (Tool)" or "Scenario (Tool)" format for all tutorials to clearly indicate the task and the tool used.

  • Example: BendSQL 连接自建 Databend (Sidebar) / 使用 BendSQL 连接自建 Databend (Title)
  • Example: Addax 离线迁移 MySQL (Sidebar) / 使用 Addax 离线迁移 MySQL (Title)

3. Content Updates

  • Removed the obsolete access-mysql-and-redis tutorial.
  • Updated query-metadata title to 查询 Stage 文件元数据 for accuracy.
  • Refreshed index.md to reflect all structural changes.

Motivation

To provide a more natural, action-oriented, and consistent guide for users, making it easier to find the right tutorial for their specific needs.

@vercel
Copy link

vercel bot commented Nov 24, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs Ready Ready Preview Comment Nov 24, 2025 2:02pm

Copy link

@chatgpt-codex-connector chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@BohuTANG BohuTANG changed the title docs: Refactor CN tutorial titles and categories for clarity and consistency docs: Refactor CN tutorial structure and naming conventions Nov 24, 2025
@BohuTANG BohuTANG merged commit f8d8efb into main Nov 24, 2025
4 checks passed
@BohuTANG BohuTANG deleted the docs/refactor-cn-tutorial-titles branch November 24, 2025 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants