Add "Building a software pack" docs site and portal convention#15
Merged
Conversation
|
📄 Docs preview for |
Replace the agent-synthesized intro and concepts with content authored faithfully from nebari.dev/docs/explanations/software-packs and nebari.dev/docs/software-packs/build-your-own. - Add what-is-a-software-pack.md: definition, why packs exist, pack contents, the NebariApp resource, pack lifecycle, official vs community - Add build-your-own.md: template quickstart, ArgoCD deployment, private and organizational packs - Rewrite _index.md to frame the guide and link to both new pages - Update hugo.toml sidebar: explanation first, build guide next, then existing reference pages; remove orphaned Concepts entry
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Gives the template its own docs site and documents how packs join the new
packs.nebari.devportal.What's here
docs/site/(usingnebari-hugo-theme, mirroring the llm-serving-pack setup), authored from the template's existingdocs/markdown (NebariApp CRD reference, auth flow, release-readiness) plus a short concepts intro. Served atpacks.nebari.dev/building-a-software-pack/..github/workflows/docs.yml): same Cloudflare Pages + per-PR preview pattern packs use. Here the slug (building-a-software-pack) intentionally differs from the CF project name (nebari-software-pack-template); the friendly slug is wired into the dashboard's extra-routes.docs_site: true, slug == repo short name == CF project name (for tracked packs), how previews work, and a pointer to the dashboard's metadata schema.This dogfoods the same deploy pattern downstream packs copy. The workflow uses the secure untrusted-input handling (branch refs passed through
env:, never inline in shell), and skips deploy on fork PRs while still building.Notes
CLOUDFLARE_*secrets (set) and thenebari-software-pack-templateCF Pages project (created).software-pack-dashboardportal PR).actionlintclean; Hugo build verified locally.