Skip to content

feat(cli): add TCR Agent-oriented CLI pages + TKE cluster management#56

Open
Kerwin0224 wants to merge 1 commit into
tke-workshop:mainfrom
Kerwin0224:feat/cli-tcr-agent-docs
Open

feat(cli): add TCR Agent-oriented CLI pages + TKE cluster management#56
Kerwin0224 wants to merge 1 commit into
tke-workshop:mainfrom
Kerwin0224:feat/cli-tcr-agent-docs

Conversation

@Kerwin0224

Copy link
Copy Markdown

Summary

Ports Agent-oriented CLI operation pages for TKE & TCR from the tke-tcr-tccli project.

Pages included

  • tccli on TKE: 集群配置/集群管理 (9 topics, 17 pages — tccli + product CLI stubs)
  • tccli on TCR: 快速入门 (4) + 操作指南 (51) + 实践教程 (18) = 73 pages
  • tkectl: 产品 CLI 占位页
  • Overview + environment setup page

Structure

  • New top-level section 面向 Agent · CLI under src/content/docs/cli/
  • Sidebar: tccli on TKE / tccli on TCR / tkectl (产品 CLI)
  • Top nav: Agent CLI entry
  • Both tccli 操作 (P0 done) and 产品 CLI 操作 (P1 stubs) included
  • 15 example JSON files co-located with pages
  • All cross-references rewritten to English slugs

Verification

  • npm run build passes (357 pages, 0 errors)
  • No duplicate <h1> headings
  • All internal links verified (200 OK)
  • Local dev server preview confirmed

Files changed

197 files, 51716 insertions

- New top-level section: 面向 Agent · CLI
  - tccli on TKE: 集群配置/集群管理 (9 topics, 17 pages)
  - tccli on TCR: full operations (quickstart/ops/practices, 76 pages)
  - tkectl (产品 CLI): placeholder
- Sidebar + top nav updated
- All cross-references rewritten to English slugs
- 357 pages, npm run build passes with 0 errors
@wenjiehs

Copy link
Copy Markdown
Collaborator

我看了一下这个 PR,目前不建议直接合并。它本地构建可以通过,但还有几个需要先处理的质量问题。

验证情况:

  • npm run build 在临时 worktree 中通过,最终 357 page(s) built
  • GitHub 当前没有 reported checks
  • PR 状态显示 mergeable=MERGEABLE,但 mergeStateStatus=UNSTABLE

建议合并前先修这些问题:

  1. git diff --check 不通过
    多个新增文件存在 trailing whitespace / EOF 空行问题,例如:

    • src/content/docs/cli/tcr/ops/access/credentials/service-credentials-tcrctl.md:8
    • 多个 *-tcrctl.md / *-tkectl.md stub 文件都有类似问题
  2. 存在异常文件名,会生成不合理路由
    例如:

    • src/content/docs/cli/tcr/ops/instance-lifecycle/.md
    • src/content/docs/cli/tcr/ops/instance-lifecycle/-tcrctl.md
    • src/content/docs/cli/tcr/ops/instances/.md
    • src/content/docs/cli/tcr/ops/instances/-tcrctl.md

    构建日志中已经出现 /cli/tcr/ops/instance-lifecycle/-tcrctl/ 这种页面,不适合作为正式文档 URL。

  3. 存在大量重复页面
    我统计到约 40 组 foo.mdfoo/foo.md 的重复结构,例如:

    • src/content/docs/cli/tcr/ops/access/credentials/service-credentials.md
    • src/content/docs/cli/tcr/ops/access/credentials/service-credentials/service-credentials.md

    这会导致搜索索引、站点地图和用户访问路径变得混乱,也会增加后续维护成本。

  4. 顶部导航需要再确认
    这个 PR 新增了顶部 Agent CLI。当前顶部导航已经比较拥挤,建议确认它是否需要作为独立顶层入口,还是放到已有栏目下更合适。

建议处理方向:

  • 保留单一路径,删除重复的 foo/foo.md 版本
  • 修正 .md-tcrctl.md 这类异常文件名和引用
  • 清理 whitespace,确保 git diff --check 通过
  • 再补一次 GitHub checks / CI 结果后合并

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