nebari-dev / nebari-dev/nebari-docs

[DOC] - Expand nebari-config examples for GPU, Node selectors, and more, for each cloud provider

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

Nobody has claimed this yet.

area: documentation 📖 content: doc/reference type: enhancement 💅🏼
Dominant language
No language data
Stars
21
Forks
40
Avg merge
19h 50m
Merged PRs (30d)
6

Description

Preliminary Checks
Summary

Occasionally, we find ourselves needing a sample at hand or pointing to some part of our documentation that details and exemplifies the uses and customizations in the configuration. For example, what is the correct structure for adding a GPU to a JupyterLab profile? Which provider uses which node selector, etc.

We need to update our documentation to include step-by-step guides and examples that cover the essentials of configuration customization, including GPU integration and the use of node selectors across different providers, as well as how exactly they should be used, scenarios, etc.

This would also ease the onboarding process for new users trying out Nebari by giving them a clearer understanding of our configuration usage. Occasionally

  • #427
  • #428
  • #425
Steps to Resolve this Issue
  1. Clarifications on the correct structures for GPU additions and insights into provider-specific node selectors

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 by reviewing the existing nebari-config documentation and the linked issues #427, #428, and #425 to identify the remaining examples. Document step-by-step GPU and provider-specific node-selector configurations, including when to use them across each cloud provider. Done means the essential structures, scenarios, and provider differences are covered with usable examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, gcp, jupyter, kubernetes
Domain
cloud, documentation, infrastructure
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.