Add placeholder landing page for Nebari Data Science Pack by killua156 · Pull Request #92 · nebari-dev/data-science-pack

killua156 · 2026-05-21T17:25:26Z

Added a placeholder landing page for the Nebari Data Science Pack documentation. Content will be filled in a follow on issue.

Mirrors the docs structure of nebari-rayserve-pack: Diataxis layout, Yarn + Netlify toolchain, lunr search, Mermaid diagrams, Nebari brand styling. Deploys automatically from netlify.toml on push to main.

killua156 · 2026-05-21T17:53:45Z

please check and review this when you can @kcpevey.
same as ray serve pack documentation:
cd docs
yarn install
yarn start
Then http://localhost:3000/.

andrewfulton9

I've added some comments throughout. Note that I am pretty new to nebari so I could be missing some context. Overall I think the content is good, but I find the organization unintuitive. For instance, if I wanted to understand the architecture. Clicking on the reference section wouldn't be my first thought. I would prefer something like:

Introduction
Deployment:

Deploy the pack
Architecture
Configuration Guide
Troubleshoot
User Guides
Use the pack from a notebook
Reference
Release Notes
Personas

I took the reference section pages from the nebari classic docs.

killua156 · 2026-05-26T01:49:11Z

I've added some comments throughout. Note that I am pretty new to nebari so I could be missing some context. Overall I think the content is good, but I find the organization unintuitive. For instance, if I wanted to understand the architecture. Clicking on the reference section wouldn't be my first thought. I would prefer something like:

Thank you for your suggested changes and input. I'm new to nebari as well so this helps me a lot. I will make the changes and try to improve the documentation more.

andrewfulton9 · 2026-06-01T18:28:48Z

Also in my experiments when deploying with nebari, I've needed to include routing configurations which I don't see documented here:

    helm:
      releaseName: data-science-pack
      values: |
        nebariapp:
          enabled: true
          routing:
            routes:
              - pathPrefix: /
         ...

@andrewfulton9

Restructure the sidebar to match @andrewfulton9's suggested layout (Introduction / Deployment / User Guides / Reference) and address all inline review comments on nebari-dev#92: - Move Architecture and Troubleshoot under Deployment; extract the Configuration guide from deploy.md into its own page; add new Release notes and Personas pages under Reference. - Apply Nebari-classic landing-page voice on intros and section indexes (persona-first "If you are..." openers, "Learn how to" CTAs). - Rename use.md to use_pack_from_notebook.md and strip kubectl/helm from end-user pages; route end users to "ask your operator" with links to the operator-side fix. - Replace stale version literals (4.3.2, sha-* image tags, 0.8-repack) in prose with links to Chart.yaml / values.yaml + chart-version stamps. - Document the routing.routes gotcha Andrew reported, in three places: the ArgoCD example in Deploy, a new "Explicit routing rules" section in the Configuration guide, and a Troubleshoot entry for the "404 with RoutingReady: True" symptom. - Add an MLflow integration section, with the wiring pattern sourced verbatim from the nebari-mlflow-pack README (extraEnv + NetworkPolicy egress on pod port 5000). - Add a GPU profile example using only the kubespawner_override traits the chart's 01-spawner.py documents (node_selector, extra_resource_limits, image); cluster-specific labels and runtime classes are left as placeholders. - Add AGENT.md at the repo root: a self-contained docs playbook for future agents/contributors covering stack, IA, voice, verification, anti-patterns, and the pre-publish checklist. Refs nebari-dev#89.

andrewfulton9

In general, the placeholder work looks good. I made a couple of comments. I was able to build and serve this locally

…EADME, drop in-progress note from introduction

killua156 · 2026-06-11T03:46:47Z

Suggested changes made.

- docusaurus.config.ts, sidebars.ts, tsconfig.json with typecheck script - Align deps with nebi: Docusaurus 3.10.1, React 19, @docusaurus/faster, @easyops-cn/docusaurus-search-local (drops the webpack pin workaround) - Switch yarn to npm (package-lock.json) - Replace deploy-docs.yml with nebi-style build-only docs.yml

killua156 · 2026-06-12T17:59:40Z

@kcpevey Suggested changes made. Also converted the docs setup to TypeScript and simplified the workflow to a build-only check (matching nebi), same as requested on the chat pack. Ready for another look.

andrewfulton9

LGTM. I verified commands in the README work as expected.

andrewfulton9 · 2026-06-15T15:37:52Z

+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*


The yarn references can be moved now

yes. removing them

andrewfulton9

should the docs gh action workflows also deploy to GH pages?

killua156 · 2026-06-17T16:13:31Z

should the docs gh action workflows also deploy to GH pages?

Not in this PR. I kept it build-only to match the chat and ray-serve packs, which don't deploy either — this is still a placeholder landing page with content coming in a follow-on issue. Adding a deploy step (GH Pages or otherwise) is a bit of a separate decision since we'd want a consistent hosting target across all the packs, and we'd also want it gated so it only publishes from main. Happy to add it here or as a follow-up once we settle on where the docs should live — @kcpevey any preference?

andrewfulton9

I added a suggestion to add the deploy step for gh pages, commit that and update the branch with main and then we are good to go.

Co-authored-by: Andrew Fulton <andrewfulton9@gmail.com>

andrewfulton9

LGTM!

kcpevey · 2026-06-23T13:21:01Z

This PR is on hold until a decision is made on the framework

docs: add Docusaurus site with Netlify deployment

5915cf0

Mirrors the docs structure of nebari-rayserve-pack: Diataxis layout, Yarn + Netlify toolchain, lunr search, Mermaid diagrams, Nebari brand styling. Deploys automatically from netlify.toml on push to main.

andrewfulton9 reviewed May 25, 2026

View reviewed changes

andrewfulton9 mentioned this pull request May 25, 2026

[DOC] - Document pack setup as an admin #89

Open

1 task

kcpevey requested a review from khuyentran1401 June 4, 2026 13:37

docs: replace full docs with placeholder landing page

8d7c949

kcpevey requested changes Jun 9, 2026

View reviewed changes

Comment thread docs/README.md Outdated

killua156 changed the title ~~docs: add Docusaurus site with Netlify deployment~~ docs: add placeholder landing page Jun 10, 2026

docs: remove all Netlify references

25c339a

killua156 changed the title ~~docs: add placeholder landing page~~ Add placeholder landing page Jun 10, 2026

killua156 changed the title ~~Add placeholder landing page~~ Add placeholder landing page for Nebari Data Science Pack Jun 10, 2026

andrewfulton9 reviewed Jun 10, 2026

View reviewed changes

Comment thread docs/README.md Outdated

andrewfulton9 approved these changes Jun 10, 2026

View reviewed changes

Comment thread docs/README.md Outdated

Comment thread docs/README.md Outdated

Remove troubleshooting section and deployment boilerplate from docs R…

41f9e40

…EADME, drop in-progress note from introduction

andrewfulton9 approved these changes Jun 12, 2026

View reviewed changes

andrewfulton9 reviewed Jun 15, 2026

View reviewed changes

andrewfulton9 mentioned this pull request Jun 15, 2026

[DOC] - Update docs package manager from yarn to npm nebari-dev/nebi-pack#28

Open

1 task

andrewfulton9 reviewed Jun 15, 2026

View reviewed changes

killua156 requested a review from kcpevey June 17, 2026 16:08

Remove yarn log references from .gitignore

a885e17

andrewfulton9 approved these changes Jun 17, 2026

View reviewed changes

Comment thread .github/workflows/docs.yml Outdated

Update .github/workflows/docs.yml

9adb7a9

Co-authored-by: Andrew Fulton <andrewfulton9@gmail.com>

andrewfulton9 approved these changes Jun 18, 2026

View reviewed changes

killua156 and others added 2 commits June 18, 2026 12:16

Merge branch 'main' into docs/docusaurus-site

cf5e554

Merge branch 'main' into docs/docusaurus-site

45cc65d

Uh oh!

Conversation

killua156 commented May 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

killua156 commented May 21, 2026

Uh oh!

andrewfulton9 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

killua156 commented May 26, 2026

Uh oh!

andrewfulton9 commented Jun 1, 2026

Uh oh!

Uh oh!

Uh oh!

andrewfulton9 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

killua156 commented Jun 11, 2026

Uh oh!

killua156 commented Jun 12, 2026

Uh oh!

andrewfulton9 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrewfulton9 Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

killua156 Jun 17, 2026

Choose a reason for hiding this comment

Uh oh!

andrewfulton9 left a comment

Choose a reason for hiding this comment

Uh oh!

killua156 commented Jun 17, 2026

Uh oh!

andrewfulton9 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

andrewfulton9 left a comment

Choose a reason for hiding this comment

Uh oh!

kcpevey commented Jun 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

killua156 commented May 21, 2026 •

edited

Loading

andrewfulton9 left a comment •

edited

Loading

andrewfulton9 left a comment •

edited

Loading