nebari-dev / nebari-dev/nebari-docs

[DOC] - Track miscellaneous documentation tasks

Open
#188 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area: documentation 📖 good first issue impact: low 🟩 type: enhancement 💅🏼
Dominant language
No language data
Stars
21
Forks
40
Avg merge
19h 50m
Merged PRs (30d)
6

Description

Preliminary Checks
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.yaml in the cloud provider specific how-tos (2nd point under Nebari initialize). It currently links to qhub.dev. And, update output from QHUB_DEFAULT_PASSWORD to 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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.