nebari-dev / nebari-dev/nebari-docs
[DOC] - Documentation Incorrect about Jhub Apps being enabled by default
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
I installed version 2024.1.1 of Nebari, and JHub Apps is not enabled by default in the main branch of Nebari or in the 2024.1.1 release.
https://www.nebari.dev/docs/how-tos/jhub-app-launcher says "JHub App Launcher is enabled by default in the Nebari after version 2023.12.1.", but it was not enabled after installation. I believe the relevant line to change would be "https://github.com/nebari-dev/nebari/blob/858ca5f477fdfeb207ecc496fb5c135f58c2b61c/src/_nebari/stages/kubernetes_services/__init__.py#L199" or alternatively update the docs depending on the desired behavior.
Steps to Resolve this Issue
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 the JHub App Launcher documentation page and compare its claim with the referenced kubernetes_services/init.py line and the 2024.1.1 release behavior. Confirm whether the intended fix is to correct the documentation or change the default, then update the documentation so its statement matches the verified behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100