nebari-dev / nebari-dev/nebari-docs
[DOC] - Track miscellaneous documentation tasks
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're working on many docs pages simultaneously. This is a broad issue to keep track of tasks that might be blocking PRs from getting merged, but can be completed at a later date.
Feel free to add comments here as things come up!
Steps to Resolve this Issue
- Link to the advanced configurations page about
nebari-config.yamlin the cloud provider specific how-tos (2nd point under Nebari initialize). It currently links toqhub.dev. And, update output fromQHUB_DEFAULT_PASSWORDto Nebari if/when that change is made. - In How-tos, "Configure Keycloak" and "Authenticate using Keycloak and launch your server", we need to add links to advanced configuration pages/sections when it's merged. The links should be added where we have text wrapped by square brackets.
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
Search the documentation for the cloud-provider-specific Nebari initialize instructions and the "Configure Keycloak" and "Authenticate using Keycloak and launch your server" pages. Update the specified links to the advanced configuration content, replace the outdated qhub.dev reference, and verify the Nebari wording and all linked sections once the dependency is available.
Written by the indexing model from the issue text.
Assessment
- Domain
- authentication, cloud, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100