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.

Sign up for GitHub

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

Jump to bottom

Configuration Management: How do we want to handle documentation? #111

Closed
jaredledvina opened this issue Apr 24, 2018 · 2 comments
Closed

Configuration Management: How do we want to handle documentation? #111

jaredledvina opened this issue Apr 24, 2018 · 2 comments

Comments

@jaredledvina
Copy link
Member

Related to #103

While we are working on the Sensu Go/2Alpha/Beta configuration management repos, how would we like to handle documentation about our various cookbooks, roles, modules, etc?

Currently, for Ansible, I'm planning to start off while most of the docs simply in the README, as that will automatically get pulled into https://galaxy.ansible.com/ when the role is official.

However, I'm totally game to align work between the CM tools so that the UX is similar.

Curious to know what everyone prefers!
@jaredledvina jaredledvina changed the title Confirguration Management: How do we want to handle documentation? Configuration Management: How do we want to handle documentation? Apr 26, 2018
@majormoses
Copy link
Member

In the chef world we mostly rely on README.md which when is pushed to the supermarket this will show up as well.

@jaredledvina
Copy link
Member Author

Sounds like everyone's going to do their own thing via the README and their platform specific setup, no further action needed for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@majormoses @jaredledvina