Skip to content

docs(software-packs): add catalog and stub pages#669

Open
khuyentran1401 wants to merge 13 commits into
mainfrom
docs/software-packs-catalog
Open

docs(software-packs): add catalog and stub pages#669
khuyentran1401 wants to merge 13 commits into
mainfrom
docs/software-packs-catalog

Conversation

@khuyentran1401

Copy link
Copy Markdown
Collaborator

Reference Issues or PRs

Fixes #662. Part of #631.

What does this implement/fix?

  • Adds a Software Packs catalog landing page with an installation overview and a single table listing every available pack.
  • Adds 11 per-pack stub pages (Chat, Data Science, LGTM, LLM Serving, Longhorn Backup, MLflow, Nebi, Pi Coding Agent, Provenance Collector, Ray Serve, Superset), each linking to its upstream repository for canonical install steps.
  • Defines what a community pack is and routes contributors to the Build your own pack flow.

Testing

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

Verified the catalog page, all 11 stubs, sidebar entries, and internal links build cleanly with npx docusaurus build.

@netlify

netlify Bot commented May 14, 2026

Copy link
Copy Markdown

Deploy Preview for nebari-docs2 ready!

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

@viniciusdc viniciusdc self-assigned this May 28, 2026
@viniciusdc viniciusdc added status: in review 👀 This PR is currently being reviewed by the team area: documentation 📖 labels May 28, 2026
@viniciusdc viniciusdc self-requested a review May 28, 2026 14:49
@viniciusdc

Copy link
Copy Markdown
Contributor

Hey @khuyentran1401, since #674 already goes deep on defining a software pack and explaining its components, and we also have a contributing one, the docs too. I don't see the benefit of listing each software pack as an extra docs page. I do like having the list of all "supported" packs in our community right now, but leaving them as is would mean keeping them in sync every time the ecosystem grows, which can quickly derail.

So instead, I would suggest you just leave the index page only, where we will have a listing of all the packs (as you already did), but I would like to go further and customize this to use JS/TS to fetch the listing @dcmcand already made, or we can check the metadata ourselves. This way, the page documents everything, and it's all automated.

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

As an action item for you right now, I would ask to remove this from this PR scope:

Adds 11 per-pack stub pages (Chat, Data Science, LGTM, LLM Serving, Longhorn Backup, MLflow, Nebi, Pi Coding Agent, Provenance Collector, Ray Serve, Superset), each linking to its upstream repository for canonical install steps.

@khuyentran1401 khuyentran1401 requested a review from viniciusdc June 1, 2026 09:27
Comment thread docs/docs/software-packs/index.mdx Outdated
@khuyentran1401 khuyentran1401 requested a review from viniciusdc June 3, 2026 02:20
Comment on lines +19 to +20
3. Open your cluster's landing page; the new capability appears there once it finishes installing.

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.

This part is not entirely true unfortuanatedly, for a pack to show up in the landing page it needs to support it already trough its nebari contract CRD (nebariApp), specificaly needs to have the nebariLanding fields populated:

  landingPage:
    enabled: true
    displayName: "Documentation"
    description: "Nebari platform documentation and guides"
    icon: "https://fontawesome.com/icons/kubernetes?f=brands&s=solid"
    category: "Platform"
    priority: 10
    healthCheck:
      enabled: true
      path: "/api/v1/health"  # webapi returns 200 {"status":"healthy"} → healthy
      intervalSeconds: 30
      timeoutSeconds: 5

example from https://github.com/nebari-dev/nebari-landing/blob/main/dev/manifests/test-nebariapps.yaml#L14-L25

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

Nice modifications, the main entry is now much better. I will try finishing looking at this during the day today, on small change that I just glanced over

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

Labels

area: documentation 📖 status: in review 👀 This PR is currently being reviewed by the team

Projects

Status: Todo 📬

Development

Successfully merging this pull request may close these issues.

Software Packs catalog: landing page and pack entries

3 participants