nebari-dev / nebari-dev/nebari-docs
[DOC] - Conda-store docs improvements
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 21
- Forks
- 40
- Avg merge
- 19h 50m
- Merged PRs (30d)
- 6
Description
Preliminary Checks
- This issue is not a question, feature request, RFC, or anything other than a bug report. Please post those things in GitHub Discussions: https://github.com/nebari-dev/nebari/discussions
Summary
We recently pushed updates to the conda-store docs. There were a few follow-up items from the review that we will still need to address, though they are less critical.
in docs/docs/tutorials/creating-new-environments.md:
- in the dask section
- Add note that the nebari-dask metapackage version should match nebari version
- also note again here that you have to be in the develop group to be able to access dask.
- source comment: https://github.com/nebari-dev/nebari-docs/pull/399/files/987df84ba49d045ef406f6d3c1ce5c27d75fe6b4#r1492948183
- for jhub apps:
- You don't need jhub-apps itself. You need jhsingle-native-proxy>=0.8.2 for all apps.
- We should point to the jhub-apps docs since they exist now.
- source comment: https://github.com/nebari-dev/nebari-docs/pull/399/files/987df84ba49d045ef406f6d3c1ce5c27d75fe6b4#r1492949828
- roles and permissions need to be reviewed/updated - but since permissions are about to change significantly, this should wait until that work is complete.
Steps to Resolve this Issue
Update the 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 with docs/docs/tutorials/creating-new-environments.md and review the linked comments from nebari-docs/pull/399. Update the Dask notes, correct the JupyterHub app dependency guidance, and link to the jhub-apps documentation. Consider the issue done when these follow-up items are reflected; defer roles and permissions until that work is complete.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100