refactor(configure): reorganize Configure section to OpenShift-aligned IA#795
Open
youyongsong wants to merge 3 commits into
Open
refactor(configure): reorganize Configure section to OpenShift-aligned IA#795youyongsong wants to merge 3 commits into
youyongsong wants to merge 3 commits into
Conversation
Contributor
|
Important Review skippedToo many files! This PR contains 175 files, which is 25 over the limit of 150. To get a review, narrow the scope: ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (13)
📒 Files selected for processing (175)
You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Deploying alauda-container-platform with
|
| Latest commit: |
2bd793a
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d6814894.alauda-container-platform.pages.dev |
| Branch Preview URL: | https://refactor-configure.alauda-container-platform.pages.dev |
…d IA Restructure the Configure section into postinstallation, clusters, hosted_control_planes, nodes, etcd, machine_config, platform_settings, backup, registry, scalability, and storage books. Promote detailed networking to the top-level Networking section and move Cluster Notification to Observability/Alerting. Relocate registry administration from developer/registry to configure/registry and rename the top-level Storage navigation to Storage Systems. Add route-map and overview pages for Configure, Postinstallation, etcd, Hosted Control Planes, Registry, Platform Settings, Scalability, and Alerting. Update doom.config.yml export scopes to match the new books and regenerate llms.txt via llmstxt-generator with persistent llmstxt-state.json for future refresh reuse. Apply full-detail documentation cleanup across touched pages: reframe Managed Cluster as the UI/navigation label with third-party cluster as the technical concept, replace replaceable product and company terms with the Term component where rendered prose allows, rewrite documentation-author prose into reader-facing guidance, fix node-planning verification output, correct scalability overview ordering, normalize overview page H1 and frontmatter, switch the Immutable Infrastructure entry to the standard ExternalSite component, and replace the Application Backup index with the standard Overview component. Preserve pre-existing global-cluster sizing values, thresholds, and validation language after Git provenance confirmed they predate the refactor (see proposals/section-refactors/acp-configure/state.md for P0/P1 inputs, review notes F-001 through F-012, and validation history). Validated with git diff --check, yarn lint (0 errors/0 warnings), and yarn build. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
CI lint task `doom-lint-check-dead-links` flagged three dead image
references on this branch:
- docs/en/configure/clusters/managed/import/huawei-cce.mdx → /zh/img/00phase.png
- docs/en/security/users_and_roles/idp/functions/ldap_manage.mdx → /en/img/113point.png
- docs/en/security/users_and_roles/idp/functions/oidc_manage.mdx → /en/img/113point.png
The reference paths predate this refactor and are unrelated to the
Configure IA work; the source MDX is unchanged. Restore the two icon
images at the referenced paths from the master copies at
docs/public/{00phase,113point}.png so the dead-link rule passes.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Post-rebase sweep to carry forward the terminology spec (PPI -> IPI; Kamaji impl note for HCP) into Configure pages and refresh stale llms.txt paths for the new Configure tree. - configure/hosted_control_planes/overview.mdx: replace "Platform-Provisioned Infrastructure" with "Installer-Provisioned Infrastructure (IPI)"; add the "implemented through Kamaji (\`TenantControlPlane\`)" clause on the page's first HCP mention. - configure/storage/cosi/cosi-concepts.mdx and intro.mdx: adopt the cleaner reader-task framing from the original PR #795 wording while keeping the MinIO removal already applied on master. - llms.txt: mechanically rewrite 43 entries to the new Configure paths (clusters/nodes -> nodes, clusters/etcd-encryption -> etcd/encryption, configure/networking -> networking, developer/registry -> configure/registry, configure/notification/cluster_notification -> observability/alerting/notification, etc.) and remove 4 entries for files deleted by either PR. Full llms.txt regeneration for newly added Configure pages remains a follow-up under the llmstxt-generator workflow. References: ACP terminology spec v0.8 sec 3.1 axis 1, sec 4.1, sec 9.2; shared ledger TW-001, TW-011, TW-013 (updated 2026-05-19). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
youyongsong
force-pushed
the
refactor-configure
branch
from
abf1125 to
2bd793a
Compare
youyongsong
changed the base branch from
master
to
refactor-install-overview-sections
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Restructure the Configure section into 11 OpenShift-aligned books and move adjacent source-of-truth content to where it actually belongs. Add new route-map / overview pages for the new books, apply a full-detail documentation-quality cleanup across touched pages, and regenerate
llms.txtso the LLM index reflects the new structure.Single squash-ready commit. 175 files changed (+4,759 / −871). Validated end to end with
git diff --check,yarn lint(0 errors / 0 warnings), andyarn build.Information architecture
Configure is split into 11 books (OpenShift-aligned but adapted to ACP's fixed top-level UI / API / Networking / Storage / Observability / Developer areas):
configure/postinstallation/configure/clusters/configure/hosted_control_planes/configure/nodes/configure/etcd/configure/machine_config/configure/platform_settings/configure/backup/configure/registry/configure/scalability/configure/storage/Source-of-truth moves (cross-section):
configure/networking/**→ top-levelnetworking/**(detailed networking is its own pillar).configure/notification/**→observability/alerting/**(cluster notification belongs with alerting).developer/registry/{intro,install,upgrade,how_to/registry_data_restore}.mdx→configure/registry/**(administration); developer-facing registry image use stays underdeveloper/registry/.configure/clusters/etcd-encryption.mdx→configure/etcd/encryption.mdx.configure/clusters/about-hcp.mdx→configure/hosted_control_planes/overview.mdx.configure/clusters/nodes/**→configure/nodes/**.configure/clusters/acp-node-planning.mdx→configure/nodes/node_planning.mdx.configure/clusters/how-to/config_resource_manager_policy.mdx→configure/scalability/resource_manager_policies.mdx.configure/feature_toggles.mdx→configure/platform_settings/feature_gates.mdx.Storagenavigation title set to Storage Systems; Kubernetes-storage use remains underconfigure/storage/.New entry / route-map pages
configure/overview.mdx— post-install / day-2 orientation.configure/postinstallation/{overview,index,prepare_users_and_access,prepare_networking,prepare_storage,prepare_registry,configure_alert_notifications,day_2_operations}.mdx.configure/etcd/{overview,index,practices}.mdx.configure/hosted_control_planes/index.mdx.configure/platform_settings/index.mdx.configure/registry/index.mdx.configure/scalability/overview.mdx.observability/alerting/{overview,index}.mdx.All new index pages use
<Overview overviewHeaders={[]} />(navigation-focused) per the standard Doom section-index pattern.Documentation-quality cleanup
Applied across refactor-touched pages:
Managed Clusteras the UI / navigation label and usethird-party clusteras the technical concept; import / register described as onboarding methods, not parallel categories.ACP/Alauda Container Platform/Alaudain rendered prose with the<Term />component, preserving exact strings for UI labels, plugin display names, YAML literals, CR labels, package names, and code/command literals.This page…,Overview pages group…,owning documentation, etc.) as user task, planning, prerequisite, or next-action guidance.third-party Kubernetes environment,external Kubernetes distribution,public cloud Kubernetes service); provider names retained only where they identify provider-specific procedure paths or exact provider-specific steps.please refer to official documentation/ generic marketing wording.Review-finding repairs
llms.txt: corrected stale registry-upgrade path and HCP summary; added conservative entries for new route-map pages (full AI regen done in this PR — see below)[Create Cluster]()placeholder in the moved Kube-OVN underlay page with a working linkapiVersion: v1) instead ofapps/v1+kind: Podobservability/alerting/overview.mdxandconfigure/etcd/overview.mdxACP/Alauda Container Platform Registryetc. with<Term />in moved alerting / images pagesensures) inconfigure/scalability/evaluating_global.mdxwhile preserving the documented datagit show HEAD:…+git blameconfirmed the global-cluster sizing values, production wording, and validation thresholds predate this refactor (commits64abbee9/3a554570from 2025-10-16/17). Pre-existing values restored verbatim and recorded as repository evidencekubectl labelcommand inconfigure/nodes/node_planning.mdxweight: 1to win against siblingweight: 10collision)title: Overviewfrontmatter on new overview pages; standardized H1s to# Overview<ExternalSite name="immutable-infra" />block while keeping<ExternalSiteLink />for specific task linksconfigure/backup/application/index.mdxwith<Overview overviewHeaders={[]} />Configuration & index updates
doom.config.yml: export scopes renamed and added to match new Configure books and the top-level Networking / Storage Systems ownership (configure_cluster→configure_clusters,configure_machine→configure_machine_config, removedconfigure_network, added new books, renamedstorage→storage_systems, keptconfigure_storage).llms.txt: fully regenerated using a sub-agent AI-reading workflow over all 513 docs; 357 unchanged file descriptions reused fromllmstxt-state.json, 156 new / changed file descriptions authored from source content.llmstxt-state.jsonis now committed for future cross-machine refresh reuse.What is not in this PR
Test plan
git diff --check origin/master...HEAD— passedyarn lint— 0 errors / 0 warningsyarn build— succeeded;dist/llms.txt(212.8 kB) anddist/llms-full.txt(9.66 MB) generatedyarn dev) and spot-check the new Configure navigation tree<ExternalSite name="immutable-infra" />block renders onconfigure/clusters/immutable-infra.mdxoverview.mdxsorts beforeevaluating_workload.mdxin navllms.txtentries for the new Configure / postinstallation / etcd / registry / alerting pages