-
Notifications
You must be signed in to change notification settings - Fork 5
Add gitops site #210
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Add gitops site #210
Conversation
WalkthroughLarge-scale documentation restructuring: numerous GitOps docs under concept, functions, how_to, install, upgrade, observability, and troubleshooting were deleted. A new overview page was added, the GitOps index title was updated, and a new site entry was added to sites.yaml. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate 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. Comment |
020fd28
to
0bfc946
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/en/gitops/index.mdx (1)
9-11
: Consider adding a direct CTA to the external GitOps docs.Optional: place under the H1 so readers can jump out immediately.
Apply:
# Alauda Container Platform GitOps +<ExternalSite name="gitops" /> + <Overview />docs/en/gitops/gitops.mdx (1)
2-6
: Add frontmatter for nav/SEO consistency.This page lacks frontmatter (title/i18n/weight). Adding it keeps it consistent with other pages and stable in the sidebar.
+--- +i18n: + title: + en: About Alauda Container Platform GitOps + zh: 关于 Alauda Container Platform GitOps +weight: 60 +--- # About Alauda Container Platform GitOpsAlso consider breaking the long paragraph into bullets for scanability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (7)
docs/en/gitops/assets/architecture_alauda_gitops.png
is excluded by!**/*.png
docs/en/gitops/assets/architecture_gitops.jpg
is excluded by!**/*.jpg
docs/en/gitops/assets/argo_cd_service_nodeport.png
is excluded by!**/*.png
docs/en/gitops/assets/new_app_button.png
is excluded by!**/*.png
docs/en/gitops/assets/new_app_button_info.png
is excluded by!**/*.png
docs/en/gitops/assets/new_app_button_repo.png
is excluded by!**/*.png
docs/en/gitops/assets/new_app_button_source.png
is excluded by!**/*.png
📒 Files selected for processing (39)
docs/en/gitops/architecture.mdx
(0 hunks)docs/en/gitops/argocd_troubleshooting.mdx
(0 hunks)docs/en/gitops/concept/alauda_gitops_concept_info/alauda_gitops_concept_argocd.mdx
(0 hunks)docs/en/gitops/concept/alauda_gitops_concept_info/alauda_gitops_concept_argocd_status.mdx
(0 hunks)docs/en/gitops/concept/alauda_gitops_concept_info/index.mdx
(0 hunks)docs/en/gitops/concept/argocd_concept_info/concept_argocd_application.mdx
(0 hunks)docs/en/gitops/concept/argocd_concept_info/concept_argocd_applicationset.mdx
(0 hunks)docs/en/gitops/concept/argocd_concept_info/concept_argocd_health.mdx
(0 hunks)docs/en/gitops/concept/argocd_concept_info/concept_argocd_sync.mdx
(0 hunks)docs/en/gitops/concept/argocd_concept_info/concept_argocd_tool.mdx
(0 hunks)docs/en/gitops/concept/argocd_concept_info/concept_argocd_tool_directory.mdx
(0 hunks)docs/en/gitops/concept/argocd_concept_info/concept_argocd_tool_helm.mdx
(0 hunks)docs/en/gitops/concept/argocd_concept_info/concept_argocd_tool_kustomize.mdx
(0 hunks)docs/en/gitops/concept/argocd_concept_info/gitops_concept_argocd.mdx
(0 hunks)docs/en/gitops/concept/argocd_concept_info/index.mdx
(0 hunks)docs/en/gitops/concept/gitops_concept_infro.mdx
(0 hunks)docs/en/gitops/concept/index.mdx
(0 hunks)docs/en/gitops/functions/argocd_observability/argocd_operator_observability.mdx
(0 hunks)docs/en/gitops/functions/argocd_observability/gitops_application_alert.mdx
(0 hunks)docs/en/gitops/functions/argocd_observability/index.mdx
(0 hunks)docs/en/gitops/functions/create_argocd_application/create_application_via_platform.mdx
(0 hunks)docs/en/gitops/functions/create_argocd_application/create_applicationset_via_platform.mdx
(0 hunks)docs/en/gitops/functions/create_argocd_application/index.mdx
(0 hunks)docs/en/gitops/functions/index.mdx
(0 hunks)docs/en/gitops/gitops.mdx
(1 hunks)docs/en/gitops/how_to/argocd_git.mdx
(0 hunks)docs/en/gitops/how_to/argocd_info.mdx
(0 hunks)docs/en/gitops/how_to/create_application_by_argocd_dashoard.mdx
(0 hunks)docs/en/gitops/how_to/create_gitops_app.mdx
(0 hunks)docs/en/gitops/how_to/index.mdx
(0 hunks)docs/en/gitops/index.mdx
(1 hunks)docs/en/gitops/install_gitops/index.mdx
(0 hunks)docs/en/gitops/install_gitops/install_argocd_operator.mdx
(0 hunks)docs/en/gitops/install_gitops/install_gitops_plugin.mdx
(0 hunks)docs/en/gitops/install_gitops/upgrade_argocd_operator.mdx
(0 hunks)docs/en/gitops/intro.mdx
(0 hunks)docs/en/gitops/upgrade/index.mdx
(0 hunks)docs/en/gitops/upgrade/upgrade_gitops_plugin.mdx
(0 hunks)sites.yaml
(1 hunks)
💤 Files with no reviewable changes (36)
- docs/en/gitops/concept/index.mdx
- docs/en/gitops/architecture.mdx
- docs/en/gitops/concept/alauda_gitops_concept_info/alauda_gitops_concept_argocd.mdx
- docs/en/gitops/functions/create_argocd_application/index.mdx
- docs/en/gitops/functions/argocd_observability/argocd_operator_observability.mdx
- docs/en/gitops/install_gitops/upgrade_argocd_operator.mdx
- docs/en/gitops/upgrade/index.mdx
- docs/en/gitops/concept/argocd_concept_info/concept_argocd_tool_directory.mdx
- docs/en/gitops/install_gitops/index.mdx
- docs/en/gitops/concept/alauda_gitops_concept_info/index.mdx
- docs/en/gitops/how_to/index.mdx
- docs/en/gitops/concept/argocd_concept_info/concept_argocd_applicationset.mdx
- docs/en/gitops/functions/index.mdx
- docs/en/gitops/concept/argocd_concept_info/concept_argocd_application.mdx
- docs/en/gitops/concept/argocd_concept_info/concept_argocd_tool_kustomize.mdx
- docs/en/gitops/how_to/create_gitops_app.mdx
- docs/en/gitops/concept/argocd_concept_info/gitops_concept_argocd.mdx
- docs/en/gitops/concept/argocd_concept_info/index.mdx
- docs/en/gitops/functions/create_argocd_application/create_applicationset_via_platform.mdx
- docs/en/gitops/functions/argocd_observability/index.mdx
- docs/en/gitops/how_to/create_application_by_argocd_dashoard.mdx
- docs/en/gitops/how_to/argocd_git.mdx
- docs/en/gitops/how_to/argocd_info.mdx
- docs/en/gitops/install_gitops/install_argocd_operator.mdx
- docs/en/gitops/install_gitops/install_gitops_plugin.mdx
- docs/en/gitops/concept/gitops_concept_infro.mdx
- docs/en/gitops/functions/argocd_observability/gitops_application_alert.mdx
- docs/en/gitops/concept/alauda_gitops_concept_info/alauda_gitops_concept_argocd_status.mdx
- docs/en/gitops/functions/create_argocd_application/create_application_via_platform.mdx
- docs/en/gitops/intro.mdx
- docs/en/gitops/concept/argocd_concept_info/concept_argocd_tool.mdx
- docs/en/gitops/concept/argocd_concept_info/concept_argocd_tool_helm.mdx
- docs/en/gitops/concept/argocd_concept_info/concept_argocd_sync.mdx
- docs/en/gitops/upgrade/upgrade_gitops_plugin.mdx
- docs/en/gitops/argocd_troubleshooting.mdx
- docs/en/gitops/concept/argocd_concept_info/concept_argocd_health.mdx
🔇 Additional comments (2)
docs/en/gitops/index.mdx (1)
5-6
: Titles align with branding; confirm Chinese localizationEN and zh both read "Alauda Container Platform GitOps" in docs/en/gitops/index.mdx (lines 5–6); ExternalSite is used at docs/en/gitops/gitops.mdx:6 and sites.yaml has name: gitops / base: /gitops (≈lines 113/117). Confirm whether the zh title should be localized or remain identical.
sites.yaml (1)
113-119
: Verification incomplete — automated checks errored; verify the newgitops
entry manuallyripgrep/regex errors prevented conclusive results. Actions to take:
- File: sites.yaml (lines 113–119) — ensure name and base are unique.
- Confirm the repo from the entry and that version "4.0" corresponds to an existing tag/branch or valid docs version.
- Suggested local checks:
awk '/^\s*-\sname:/{print $NF}' sites.yaml | sort | uniq -c | sort -nr
awk '/^\sbase:/{print $2}' sites.yaml | sort | uniq -c | sort -nr
sed -n '110,125p' sites.yaml
git ls-remote --tags --heads | rg '4.0' || echo "no 4.0 tag/branch"
rg -n 'gitops/' docs -g '!/node_modules/' || echo "no obvious stale GitOps links"
Summary by CodeRabbit