nebari-dev / nebari-dev/nebari-docs

[DOC] Migrate day-to-day maintenance guide

Open
#121 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area: documentation 📖 content: doc/how-to good first issue old-doc-migration
Dominant language
No language data
Stars
21
Forks
40
Avg merge
19h 50m
Merged PRs (30d)
6

Description

Preliminary Checks
Summary

Link to old docs: https://github.com/nebari-dev/nebari/blob/d053784a80fb4d461a9c3f5dd324dce75e884ca2/docs/source/admin_guide/system_maintenance.md

The contents of this page needs to be migrated into the new docs. I don't think it should be added as its own page, but added to other existed pages (like a configuration guide)

Steps to Resolve this Issue
  • Review existing content in old docs
  • Convert into how-to guide
  • Submit PR to add to docs/how-tos

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 docs/source/admin_guide/system_maintenance.md at the linked revision, then inspect the existing pages and structure under docs/how-tos. Rework the maintenance content as a how-to and incorporate it into relevant existing documentation rather than creating a standalone page. Done means the old guide’s useful content is available in the new docs structure.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.