Skip to content

Register Artifact Hub Shim docs site#151

Open
yuzichen12123 wants to merge 1 commit into
mainfrom
docs/register-artifacthub-shim
Open

Register Artifact Hub Shim docs site#151
yuzichen12123 wants to merge 1 commit into
mainfrom
docs/register-artifacthub-shim

Conversation

@yuzichen12123

@yuzichen12123 yuzichen12123 commented Jun 23, 2026

Copy link
Copy Markdown

Summary

  • Register the Artifact Hub Shim documentation subsite in sites.yaml.
  • Add the parent DevOps docs entry pages for the subsite.

Verification

  • yarn install --immutable
  • yarn lint
  • sites.yaml parsing and duplicate name/base check
  • git diff --check

Notes

  • yarn build is blocked in this environment because docs/en/overview/release_notes.mdx requires JIRA_USERNAME and JIRA_PASSWORD.
  • Checked ../artifacthub-shim origin/main: doc-build matches push events on main/master/release branches and uses doc-base alauda-devops-artifacthub-shim, which matches this registration.

Summary by CodeRabbit

  • Documentation
    • Introduced new documentation for Alauda DevOps Artifact Hub Shim, including overview and about pages with complete information architecture.
    • Registered new documentation site with routing configuration and localized content support.

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 456719ea-7352-40c2-ac81-5922a2c0bf5d

📥 Commits

Reviewing files that changed from the base of the PR and between 6d98cec and ac2a2c6.

📒 Files selected for processing (3)
  • docs/en/artifacthub-shim/about.mdx
  • docs/en/artifacthub-shim/index.mdx
  • sites.yaml

Walkthrough

A new documentation section for "Artifact Hub Shim" is introduced by registering a new site entry (alauda-devops-artifacthub-shim) in sites.yaml and adding two MDX pages (index.mdx and about.mdx) under docs/en/artifacthub-shim/.

Changes

Artifact Hub Shim Documentation

Layer / File(s) Summary
Site registration
sites.yaml
Adds the alauda-devops-artifacthub-shim site entry with localized display names, route base /alauda-devops-artifacthub-shim, version: main, repository URL, and docs image. The existing alauda-devops version: v3.20 line is unchanged.
MDX index and about pages
docs/en/artifacthub-shim/index.mdx, docs/en/artifacthub-shim/about.mdx
Adds index.mdx (weight 120) rendering <Overview overviewHeaders={[]} /> and about.mdx (weight 130) rendering an <ExternalSite> reference to alauda-devops-artifacthub-shim.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 Hippity-hop, a new shim's in sight,
Three files were added with frontmatter tight.
A YAML entry, two MDX pages bright,
The Artifact Hub Shim now joins the site!
This bunny approves — the docs look just right. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: registering a new Artifact Hub Shim documentation site in sites.yaml with corresponding documentation pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/register-artifacthub-shim

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.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying alauda-devops-hqfztc with  Cloudflare Pages  Cloudflare Pages

Latest commit: ac2a2c6
Status: ✅  Deploy successful!
Preview URL: https://7684f196.alauda-devops-hqfztc.pages.dev
Branch Preview URL: https://docs-register-artifacthub-sh.alauda-devops-hqfztc.pages.dev

View logs

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