linux-system-roles / storage

Ansible role for linux storage management
https://linux-system-roles.github.io/storage/
MIT License
101 stars 59 forks source link

docs: add Collection requirements section to README #353

Closed richm closed 1 year ago

richm commented 1 year ago

For roles that use external collections, they have a meta/collection-requirements.yml file, and the README lists these requirements and instructions. However, these are only required for github and Galaxy users, and not for users who use the packaged roles, where it is confusing to see instructions about installing requirements when none are needed. We need to make it easier to remove these sections when packaging.

Use regular markdown header style rather than alternate header style to make the README easier to parse.

Signed-off-by: Rich Megginson rmeggins@redhat.com

codecov[bot] commented 1 year ago

Codecov Report

Patch and project coverage have no change.

Comparison is base (1b4b4c5) 13.90% compared to head (f3bae69) 13.90%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #353 +/- ## ======================================= Coverage 13.90% 13.90% ======================================= Files 8 8 Lines 1705 1705 Branches 71 71 ======================================= Hits 237 237 Misses 1468 1468 ``` | Flag | Coverage Δ | | |---|---|---| | sanity | `16.54% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=linux-system-roles#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.