Skip to content

docs(explanations): add NKP architecture explainer page#668

Open
khuyentran1401 wants to merge 15 commits into
mainfrom
docs/nkp-architecture-explainer
Open

docs(explanations): add NKP architecture explainer page#668
khuyentran1401 wants to merge 15 commits into
mainfrom
docs/nkp-architecture-explainer

Conversation

@khuyentran1401
Copy link
Copy Markdown
Collaborator

@khuyentran1401 khuyentran1401 commented May 13, 2026

Reference Issues or PRs

Fixes #666. Fixes #636. Part of #625.

What does this implement/fix?

  • Adds a new explainer page at /docs/explanations/nkp-architecture covering how the layers fit together, what the nic CLI does (and doesn't do), how GitOps via ArgoCD delivers everything above the cluster, and how nic tracks state with locking.
  • Includes architecture diagrams (PNG + editable HTML source & Mermaid).
  • Edits the welcome ecosystem diagram.

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Verified locally with yarn start: the new page renders, the sidebar entry navigates correctly, and the diagram images load on both light and dark themes.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 13, 2026

Deploy Preview for nebari-docs2 ready!

Name Link
🔨 Latest commit 9bcb696
🔍 Latest deploy log https://app.netlify.com/projects/nebari-docs2/deploys/6a102fc66a674d0009c1cd9b
😎 Deploy Preview https://deploy-preview-668--nebari-docs2.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.

Comment thread docs/docs/explanations/nkp-architecture.mdx Outdated
Comment thread docs/docs/explanations/nkp-architecture.mdx Outdated
Comment thread docs/docs/explanations/nkp-architecture.mdx Outdated
Comment thread docs/docs/introduction.mdx Outdated
@khuyentran1401 khuyentran1401 requested a review from dcmcand May 22, 2026 10:29
Copy link
Copy Markdown
Contributor

@dcmcand dcmcand left a comment

Choose a reason for hiding this comment

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

Thanks for the thorough revisions, @khuyentran1401! All of dcmcand's review comments look addressed:

  • End-user framing for Capabilities is now front and center
  • Software Pack ecosystem (official + community/business packs) is called out in both pages
  • State/locking section is correctly scoped to OpenTofu providers, with Hetzner noted as the exception
  • The "central registry" framing is replaced with GitHub publishing

Nice work on this explainer.

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

Labels

None yet

Projects

Status: Todo 📬

Development

Successfully merging this pull request may close these issues.

Write the NKP architecture explainer page NKP layered architecture diagram

2 participants