Skip to content

refactor: create platforms directory for cloud vendor guides - #804

Open
Junie06 wants to merge 1 commit into
Project-HAMi:masterfrom
Junie06:refactor/installation-platforms-directory
Open

refactor: create platforms directory for cloud vendor guides#804
Junie06 wants to merge 1 commit into
Project-HAMi:masterfrom
Junie06:refactor/installation-platforms-directory

Conversation

@Junie06

@Junie06 Junie06 commented Aug 20, 2026

Copy link
Copy Markdown

What type of PR is this?

/kind cleanup
/kind documentation

What this PR does / why we need it:
Restructures installation documentation by placing cloud vendor/platform guides into a dedicated directory

Which issue(s) this PR fixes:

  • Created docs/installation/platforms directory for vendor guides
  • Moved AWS guide from docs/installation/aws-installation.md‎ to docs/installation/platforms/aws.md
  • Updated relative link for adjusting configuration in aws.md to match new directory depth
  • Updated sidebars.js to introduce a Cloud Platforms section under Installation
  • Updated Chinese translation directory structure to match

Fixes #795

Checklist:

  • npm run lint and npm run format:check pass
  • npm run build succeeds for both en and zh
  • Chinese translation updated if English docs changed
  • Commits are signed off (git commit -s)

@hami-robot hami-robot Bot added the kind/cleanup Refactoring, config, or tidy-up with no behavior change label Aug 20, 2026
@hami-robot
hami-robot Bot requested review from archlitchi and windsonsea August 20, 2026 11:47
@hami-robot hami-robot Bot added the kind/documentation Improvements or additions to documentation label Aug 20, 2026
@hami-robot

hami-robot Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Junie06
Once this PR has been reviewed and has the lgtm label, please assign windsonsea for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@netlify

netlify Bot commented Aug 20, 2026

Copy link
Copy Markdown

Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit 0393284
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/6a86eada8fb3c00008fcb652
😎 Deploy Preview https://deploy-preview-804--project-hami.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Aug 20, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: eaeb1981-fb49-4ad8-acd9-21eb5eff1a3b

📥 Commits

Reviewing files that changed from the base of the PR and between b5a333c and 6243b01.

📒 Files selected for processing (3)
  • docs/installation/platforms/aws.md
  • i18n/zh/docusaurus-plugin-content-docs/current/installation/platforms/aws.md
  • sidebars.js

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The AWS installation guide is now grouped under a new Cloud Platforms sidebar category. Its English and Chinese configuration links use the corrected relative path.

Changes

Installation documentation

Layer / File(s) Summary
Cloud Platforms navigation
sidebars.js
The Installation sidebar now contains a Cloud Platforms category with the AWS guide.
AWS guide link correction
docs/installation/platforms/aws.md, i18n/zh/docusaurus-plugin-content-docs/current/installation/platforms/aws.md
The English and Chinese guides now link to the configuration guide through the corrected relative path.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: 🔵 Low · up to 6243b

The AWS guide’s move changes its public URL, so existing links and bookmarks may stop working unless a redirect is added. The PR is otherwise mergeable with explicit owner follow-up on this bounded documentation-routing risk.

Possibly related PRs

Suggested reviewers: archlitchi, windsonsea

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning The changes support the documentation structure requirement in [#795] but do not add the requested platform-specific installation guidance for the listed platforms. Add the required GKE, AKS, CCE, TKE, IBM Cloud, and OpenShift guides with prerequisites, platform configuration, verification, troubleshooting, sidebar entries, and Chinese mirrors.
✅ Passed checks (4 passed)
Check name Status Explanation
Out of Scope Changes check ✅ Passed The directory move, corrected links, sidebar category, and Chinese mirror changes are related to the documentation restructuring described in [#795].
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main documentation restructure by creating a platforms directory for cloud vendor guides.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Signed-off-by: Isoken <isokenjune@gmail.com>
@Junie06
Junie06 force-pushed the refactor/installation-platforms-directory branch from 6243b01 to 0393284 Compare August 20, 2026 11:54

@mesutoezdil mesutoezdil left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

clean move: relative links fixed at both depths, no other page links the old path, and the frozen v2.9.0 snapshot correctly keeps its copy. one gap inline. note the url changes from /installation/aws-installation to /installation/platforms/aws on next docs, low risk but worth a line in the pr body.

Comment thread sidebars.js
"installation/how-to-use-volcano-ascend",
{
type: "category",
label: "Cloud Platforms",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

new category label needs a zh entry in i18n/zh/.../current.json, sidebar.docs.category.Cloud Platforms, otherwise the zh sidebar shows english.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs area/i18n kind/cleanup Refactoring, config, or tidy-up with no behavior change kind/documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add platform-specific installation guides: GKE, AKS, Huawei Cloud CCE, Tencent TKE, IBM Cloud, OpenShift, etc.

2 participants