nebari-dev / nebari-dev/nebari-docs

[ENH] - Improve the how-tos and get started around deploying nebari and k3s

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

Nobody has claimed this yet.

needs: triage 🚦
Dominant language
No language data
Stars
21
Forks
40
Avg merge
19h 50m
Merged PRs (30d)
6

Description

Context

Our current docs are challenging to navigate, and are missing information around the k3s support for users looking for extra information.

https://www.nebari.dev/docs/get-started/deploy
https://www.nebari.dev/docs/get-started/quickstart

Value and/or benefit
  • better guidance for our users
Anything else?

No response

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

Start with the deploy and quickstart pages linked in the issue, then review how they currently explain Nebari deployment and k3s support. Done means the how-tos are easier to navigate and provide the missing k3s guidance for users.

Written by the indexing model from the issue text.

Assessment

Tech stack
kubernetes
Domain
devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.