docs(software-packs): add catalog and stub pages#669
Conversation
✅ Deploy Preview for nebari-docs2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
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
left a comment
There was a problem hiding this comment.
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.
| 3. Open your cluster's landing page; the new capability appears there once it finishes installing. | ||
|
|
There was a problem hiding this comment.
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: 5example from https://github.com/nebari-dev/nebari-landing/blob/main/dev/manifests/test-nebariapps.yaml#L14-L25
viniciusdc
left a comment
There was a problem hiding this comment.
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
Reference Issues or PRs
Fixes #662. Part of #631.
What does this implement/fix?
Testing
Verified the catalog page, all 11 stubs, sidebar entries, and internal links build cleanly with
npx docusaurus build.