nebari-dev / nebari-dev/data-science-pack
README: add prerequisites and known limitations sections
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 7
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 13
Description
Checklist items [A]:
Prerequisites documented (NIC version, cluster sizing, namespace labels, external dependencies)
README includes prerequisites and a "Known Limitations" section
The README's only prerequisites today are local-dev tooling (Docker, ctlptl, Tilt). Missing for a customer pilot:
- Supported NIC version(s) and the nebari-operator dependency (NebariApp CRD, OIDC client provisioning)
- Keycloak expectations (bitnami/keycloakx,
keycloaknamespace,nebarirealm, admin credentials secret for the rbac bootstrap job) - RWX StorageClass requirement for shared storage (currently buried in the Shared Storage section)
- Rough cluster sizing
Known limitations should collect what is currently scattered: the in-cluster NFS server workaround and its tracked removal (#29), the z2jh extraVolumes/extraVolumeMounts replace-not-merge behavior, and anything else the team knows about.
Part of #120. Related: #89 (admin setup docs).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the repository README, including its current prerequisites and Shared Storage section, then review the details and related issues #29 and #89. Update the README with the requested NIC, cluster, namespace, dependency, Keycloak, storage, and sizing prerequisites, plus a Known Limitations section covering the listed constraints and tracked NFS removal.】【。} ilaasort经彩票? Nope invalid because accidental? Need ensure valid JSON, research string has weird unicode? I see final ended
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100