nebari-dev / nebari-dev/data-science-pack
[DOC] - Document end user workflow
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 7
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 13
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 need to publish standalone documentation of this software pack. The theme should be the same as the nebari docs theme, but these docs will be managed and published separately, in this repo.
This documentation is focused on the end user. It should answer questions like:
- How do I log in?
- How do I launch JupyterHub/select a server?
- What are the extra things on the JLab landing page (i.e. jupyter gallery)?
- How do I access environments?
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
No file or test paths are named. Start by locating the repository's current documentation and the Nebari docs theme configuration, then map the standalone publishing workflow. Done means separately published end-user documentation covering login, launching JupyterHub and selecting a server, the JupyterLab landing-page extras, and accessing environments.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100