Skip to content

docs: align the Introduction and other pages with the glossary - #776

Merged
khuyentran1401 merged 6 commits into
mainfrom
docs/align-docs-with-glossary
Nov 6, 2026
Merged

khuyentran1401 merged 6 commits into
mainfrom
docs/align-docs-with-glossary

Conversation

@khuyentran1401

@khuyentran1401 khuyentran1401 commented Nov 3, 2026 •

Copy link
Copy Markdown
Collaborator

Why

Pages used Nebari's core terms in different ways than the glossary defines them. Readers now see each term used one way across the docs.

Reference Issues or PRs

Fixes #758. Part of #747. See also #777.

What does this implement/fix?

  • All pages, including the Introduction, use the glossary's terms and capitalization.
  • Terms a page doesn't explain link to the glossary, and the Introduction defines each term once.

Testing

  • Did you test the pull request locally?

  • Did you add new tests?

  • Checked every glossary anchor the new links use.

@github-actions

github-actions Bot commented Nov 3, 2026

Copy link
Copy Markdown

Docs preview for docs/align-docs-with-glossary:

@jbouder jbouder 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.

The changes match the glossary and all new anchors resolve. A few pages still use the old terms, so #758 isn't fully closed yet. Two notes are inline. These files aren't in the diff:

  • explanations/software-packs.mdx:54 says the pack appears on the landing page "as an available Capability." Per the glossary and this PR's nkp-architecture change, that should be "Service."
  • how-tos/providers/hetzner.md:125 still says "foundational services."
  • software-packs/build-your-own.md:10 and software-packs/deploy-a-pack.md:3 use lowercase "software pack."

The alternative is to narrow the "all pages" claim in the description.

@dcmcand dcmcand 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.

Verdict: Request changes. The renames of "foundational software" and "Software Pack" are clean. But the Introduction replaces "Capability" with "tool", which isn't in the glossary, and uses it for packs, Services and Capabilities alike. So #758 isn't fixed yet. jbouder's notes already cover nkp-architecture.mdx:31, install.mdx:9, and the leftovers outside the diff.


Key: 🛑 Blocker (must fix before merge) · 💡 Suggestion (improvement, not blocking) · ❓ Question (needs author input) · ❤️ Kudos

Nebari Kubernetes Platform (NKP) is how end users get to AI [Capabilities](/docs/references/glossary/#capability) like chat assistants, document analyzers, and code review tools, without their team having to assemble a platform first.

Developers package each capability as a **Software Pack**. NKP wires in login, routing, TLS, and observability, so users just open the landing page and click in.
Developers publish these tools as [Software Packs](/docs/references/glossary/#software-pack). NKP wires in login, routing, TLS, and observability, so users just open the landing page and click in.

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.

🛑 Blocker: "These tools" points back to the Capabilities on :9, so this sentence says Capabilities are Software Packs.

Suggested change
Developers publish these tools as [Software Packs](/docs/references/glossary/#software-pack). NKP wires in login, routing, TLS, and observability, so users just open the landing page and click in.
Developers package the Services that provide them as [Software Packs](/docs/references/glossary/#software-pack). NKP wires in login, routing, TLS, and observability, so users just open the landing page and click in.

---

NKP supports two production deploy targets today, plus a local provider for developing and testing on your own machine. The other providers are partially built but not yet usable; their pages describe the current state and how to follow progress.
NKP supports two production providers today, plus a local provider for developing and testing on your own machine. The other providers are partially built but not yet usable; their pages describe the current state and how to follow progress.

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.

💡 Suggestion: Azure can already be deployed in NIC, so "two production providers" is wrong. "Providers" is also the unqualified form that the glossary splits into three kinds.
Say "Cluster Providers" here and in the description at :3. Then file a follow-up to replace the stub in azure.mdx and mark Azure Supported at :13.
NIC registers Azure in pkg/nic/registry.go. azure.Deploy runs tofu.Setup and Apply against the aks-cluster module, and CI has an Azure deployment-test job. GCP is still a stub.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Done. I also filed #777 for the Azure page and the Supported status.

khuyentran1401 and others added 2 commits November 4, 2026 21:06
Co-authored-by: Chuck McAndrew <6248903+dcmcand@users.noreply.github.com>
Co-authored-by: Chuck McAndrew <6248903+dcmcand@users.noreply.github.com>

@dcmcand dcmcand 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.

Verdict: Approve. Every term the Introduction and the other pages use now matches the glossary. The suggestions inline are all small.

💡 Suggestion: references/glossary.md:10 still says "Different tools can provide the same Capability", so the glossary itself still uses "tool". The glossary isn't in this PR, so this could be a follow-up: change "tools" to "Services", since glossary.md:68 says Services provide Capabilities.

Reviewer Item Disposition
dcmcand 🛑 Introduction uses "tool" for packs, Services and Capabilities (:11, :26-28, :34) Fixed in ec4535e8, a01d5dbb, 05f35405. The glossary's own "tools" is carried as a suggestion above.
dcmcand 🛑 nkp-architecture.mdx:11 says Capabilities are Software Packs Fixed in 05f35405
dcmcand 🛑 Introduction :40 defines a pack by its GitHub hosting Fixed in 05f35405, including software-packs/index.mdx:8
dcmcand 💡 Introduction :60 "NKP sets up" Fixed
dcmcand 💡 Introduction :72 "catalog of Capabilities" Fixed
dcmcand 💡 providers/index.md:6 "two production providers" Fixed. Azure is deferred to #777.
dcmcand 💡 nkp-architecture.mdx:35 Operator "deploys" packs Fixed
jbouder nkp-architecture.mdx:31 "an installable Capability" Fixed
jbouder install.mdx:9 "platform essentials" Fixed
jbouder software-packs.mdx:54, hetzner.md:125, lowercase "software pack" Fixed

Key: 🛑 Blocker (must fix before merge) · 💡 Suggestion (improvement, not blocking) · ❓ Question (needs author input) · ❤️ Kudos

## What is Nebari?

**Nebari is an open-source ecosystem for AI platforms.** It's similar to HuggingFace Hub, but for infrastructure: teams browse and install capabilities (document analysis, image generation, chat assistants, code review, and more) onto a platform they control.
**Nebari is an open-source ecosystem for AI platforms.** Teams add AI [Capabilities](/docs/references/glossary/#capability), such as chat assistants, document analysis, image generation, and code review, by installing ready-made packages on a platform they control.

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.

💡 Suggestion: "ready-made packages" is a fourth name for a Software Pack, and the glossary doesn't define it.

Suggested change
**Nebari is an open-source ecosystem for AI platforms.** Teams add AI [Capabilities](/docs/references/glossary/#capability), such as chat assistants, document analysis, image generation, and code review, by installing ready-made packages on a platform they control.
**Nebari is an open-source ecosystem for AI platforms.** Teams add AI [Capabilities](/docs/references/glossary/#capability), such as chat assistants, document analysis, image generation, and code review, by installing [Software Packs](/docs/references/glossary/#software-pack) on a platform they control.

2. **ArgoCD deploys the pack's workloads and the `NebariApp` into the cluster.**
3. **The Nebari Operator picks up the `NebariApp`** and creates the routing, certificate, and Keycloak client that the pack needs.
4. **The pack appears on the [landing page](https://github.com/nebari-dev/nebari-landing)** as an available Capability.
4. **The pack appears on the [landing page](https://github.com/nebari-dev/nebari-landing)** as an available Service.

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.

💡 Suggestion: This step says the pack is a Service, but a pack adds one or more Services (glossary.md:72).

Suggested change
4. **The pack appears on the [landing page](https://github.com/nebari-dev/nebari-landing)** as an available Service.
4. **The pack's Services appear on the [landing page](https://github.com/nebari-dev/nebari-landing).**

Nebari Infrastructure Core (NIC) is a CLI that sets up a production-grade Kubernetes cluster and installs the [foundational software](/docs/references/glossary/#foundational-software) that runs on top of it, such as authentication (SSO), user management, observability, and TLS certificates.

You can set up software packs (like the data science pack for specific tools like JupyterLab) on top of this layer.
You can set up Software Packs (like the data science pack for specific tools like JupyterLab) on top of this layer.

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.

💡 Suggestion: "specific tools like JupyterLab" uses "tool" for a Service, which the Introduction no longer does.

Suggested change
You can set up Software Packs (like the data science pack for specific tools like JupyterLab) on top of this layer.
You can set up Software Packs (like the data science pack, which adds JupyterLab) on top of this layer.

@khuyentran1401
khuyentran1401 merged commit 223818e into main Nov 6, 2026
2 checks passed
@khuyentran1401
khuyentran1401 deleted the docs/align-docs-with-glossary branch November 6, 2026 08:42
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.

Align the rest of the docs with the glossary

3 participants