bottlerocket-os / bottlerocket-os/bottlerocket-update-operator

Refactor README to reduce duplication with `bottlerocket.dev/en/brupop/`

Open
#596 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
220
Forks
50
PR merge metrics
No merged PRs in 30d

Description

**Image I'm using:**
n/a

**Issue or Feature Request:**

Brupop Documentation launched on Feb 14 and there is substantial overlap with the README. To reduce duplication, we should people interested in running Brupop to the docs and focus the readme to contributors and development.

Contributor guide

Open the contributing guide

Research direction

Start with the repository README and compare its Brupop user-facing content with the documentation at bottlerocket.dev/en/brupop/. Identify duplicated material and the sections aimed at users versus contributors or developers. Done means the README directs users to the documentation while retaining relevant contributor and development information.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.