Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update collection readme to comply with the template #351

Merged
merged 2 commits into from
Sep 13, 2024

Conversation

spetrosi
Copy link
Contributor

@spetrosi spetrosi commented Sep 13, 2024

https://access.redhat.com/articles/7068606 introduces a Certified Collections README Template that we want to comply with
I kept content that was in the readme before, and add some to fill in suggested sections.
I left out the ## Testing section, it does not provide any helpful info for users imo, we describe how we test in our GitHub page https://linux-system-roles.github.io/.

https://access.redhat.com/articles/7068606 introduces a Certified
Collections README Template that we want to comply with
@spetrosi spetrosi self-assigned this Sep 13, 2024
@spetrosi spetrosi requested a review from richm September 13, 2024 12:43
@spetrosi spetrosi changed the title Update collection readme to comply with the template doc: Update collection readme to comply with the template Sep 13, 2024
## Documentation
## Use Cases

This collection provides Anible roles that manage different Linux subsystems.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This collection provides Anible roles that manage different Linux subsystems.
This collection provides Ansible roles that manage different Linux subsystems.

@spetrosi spetrosi changed the title doc: Update collection readme to comply with the template docs: Update collection readme to comply with the template Sep 13, 2024
@richm richm merged commit 7ae3071 into linux-system-roles:main Sep 13, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants