containers / containers/nri-plugins

Needed documentation changes

Open
#58 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
114
Forks
44
Avg merge
1d 8h
Merged PRs (30d)
20

Description

Copied here the extra work items from #6

* `docs/resource-policy/setup.md`: move node-agent/dynamic configuration document to better document
* `docs/resource-policy/setup.md`: move installation instructions etc. related items to installation.md file
* `docs/resource-policy/setup.md`: move the "Logging and debugging" chapter to separate file or optionally to configuration doc.
* `docs/resource-policy/README.md`: this is probably not needed or perhaps some of the information could be moved to existing file

Contributor guide

Open the contributing guide

Research direction

Start by reading issue #6 and the current contents of docs/resource-policy/setup.md and docs/resource-policy/README.md. Move the node-agent/dynamic configuration, installation, and logging/debugging material into appropriately named documentation, then decide whether README.md is still needed or what useful information belongs there. Done means the resource-policy documentation is organized without duplicated or misplaced sections.

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.