kubereboot/website

ensure CLI docs are consistent with actual CLI args interface

Open

#70 opened on Jun 23, 2021

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Python (10 forks)auto 404
good first issue

Repository metrics

Stars
 (5 stars)
PR merge metrics
 (PR metrics pending)

Description

  1. Fix any existing inconsistencies
  2. Write tests and integrate into UT suite so that consistency is preserved

Contributor guide

Research direction
Compare the CLI documentation with the actual CLI implementation in the codebase, identify inconsistencies, and write tests to enforce consistency.
Tech stack
pythonshell
Domain
documentationtestingcli
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65