Skip to content
This repository has been archived by the owner on Oct 9, 2018. It is now read-only.

Add README.md files per role #48

Open
hairmare opened this issue Feb 17, 2018 · 0 comments
Open

Add README.md files per role #48

hairmare opened this issue Feb 17, 2018 · 0 comments

Comments

@hairmare
Copy link
Contributor

The default of documenting individual roles with a markdown file is considered a best-practice and we should consider closing addressing this.

The ansible-galaxy commands init creates a default README that can be used as a basis to creating our own template. This template can then be used as an input to ansible-galaxy init --role-skeleton=/path/to/skeleton role_name (it's jinja2) enabling us to ensure consistant use of READMEs.

We might also want to consider letting the update docs probot help us remember to keep the docs up to date.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants