Skip to content

docs(deploy): add System Requirements and Build Instructions pages - #88

Merged
szbr00 merged 1 commit into
mainfrom
docs/deploy-system-requirements-build-instructions
Aug 14, 2026
Merged

docs(deploy): add System Requirements and Build Instructions pages#88
szbr00 merged 1 commit into
mainfrom
docs/deploy-system-requirements-build-instructions

Conversation

@szbr00

@szbr00 szbr00 commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Summary

Add the System Requirements and Build Instructions sections from the repository README as two new sub-pages under the Deploy module, placed directly after Quick Start. Includes zh-cn i18n translations and renumbers the existing Deploy Curvine Cluster / Transfer Service category positions so the new pages sit between Quick Start and Deploy Curvine Cluster in the sidebar.

Issue Describe / Design

N/A — no tracking issue.

The goal is to surface the README's build/requirements overview inside the Deploy chapter of the docs site. Cross-links are added to the existing detailed preparation (01-prerequisites.md) and compile (02-compile.md) pages so this PR acts as a quick overview rather than duplicating the in-depth guides.

Changes

Module / File Change Impact on existing behavior
docs/2-Deploy/2-system-requirements.md New page (English) None
docs/2-Deploy/3-build-instructions.md New page (English) None
i18n/zh-cn/.../2-Deploy/2-system-requirements.md New page (zh-cn) None
i18n/zh-cn/.../2-Deploy/3-build-instructions.md New page (zh-cn) None
docs/2-Deploy/2-Deploy-Curvine-Cluster/_category_.json position 1 → 3 Sidebar order: moves below new pages
docs/2-Deploy/3-Transfer-Service/_category_.json position 3 → 4 Sidebar order
i18n/zh-cn/.../2-Deploy-Curvine-Cluster/_category_.json position 1 → 3 Sidebar order
i18n/zh-cn/.../3-Transfer-Service/_category_.json position 3 → 4 Sidebar order

New page sidebar ordering (after this PR):

  1. Deployment Overview
  2. Quick Start
  3. System Requirements (new)
  4. Build Instructions (new)
  5. Deploy Curvine Cluster
  6. Transfer Service

Test verified

Test case Result Notes
Markdown frontmatter + structure review PASS Manually verified
Sidebar position ordering review PASS Verified against Docusaurus autogenerated rules

Dependencies

  • Related PRs: None
  • Related issues: None
  • Blocks / blocked by: None

Add the System Requirements and Build Instructions sections from the
repository README as two new sub-pages under the Deploy module, placed
right after Quick Start. Includes zh-cn i18n translations and renumbers
the existing Deploy Curvine Cluster / Transfer Service category positions
so the new pages sit between Quick Start and Deploy Curvine Cluster in
the sidebar. Cross-links point to the existing detailed preparation and
compile pages to avoid content duplication.

Co-authored-by: Cursor <cursoragent@cursor.com>
@szbr00
szbr00 marked this pull request as ready for review August 14, 2026 12:02
@szbr00
szbr00 merged commit 916b1fe into main Aug 14, 2026
2 checks passed
@lzjqsdd
lzjqsdd deleted the docs/deploy-system-requirements-build-instructions branch August 14, 2026 12:19
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.

1 participant