nebari-dev / nebari-dev/nebari-docs

[DOC] - Review installation and setup docs for each cloud provider

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

Nobody has claimed this yet.

area: documentation 📖
Dominant language
No language data
Stars
21
Forks
40
Avg merge
19h 50m
Merged PRs (30d)
6

Description

Preliminary Checks
Summary

Nebari has recently changed a lot since we first wrote the cloud provider guides on setting up accounts and performing the first. deployment, many changes might have changed internally within the provider's own docs as well as upstream within nebari (libs or requirements might've changed)

The goal is to review these pages and ensure they are concise and up to date. Deployment

Steps to Resolve this Issue
  1. Identify, if present, issues with the current setup docs for each provider and remediate with respective PRs
  2. Assert the steps outlined in the docs are still "feasible," leading to a successful deployment of nebari.
    ...

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 locating the installation and account-setup pages for each cloud provider, then compare their steps with the current Nebari deployment requirements and the providers' documentation. Confirm that the documented process remains feasible through a successful deployment, and update the affected pages so they are concise and current.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, gcp, kubernetes
Domain
cloud, documentation
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.