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

Add example playbooks #55

Open
vexx32 opened this issue Jun 2, 2021 · 2 comments
Open

Add example playbooks #55

vexx32 opened this issue Jun 2, 2021 · 2 comments
Labels
0 - Backlog Issue is accepted, but is not ready to be worked on or not in current sprint Documentation Issues for changes that only need to change documentation Improvement Issues that enhances existing functionality, or adds new features
Milestone

Comments

@vexx32
Copy link
Member

vexx32 commented Jun 2, 2021

We should include more examples of how to use the collection for various tasks, as well as some 'complete' scenarios to illustrate how the modules can be used together.

@vexx32 vexx32 added Documentation Issues for changes that only need to change documentation Improvement Issues that enhances existing functionality, or adds new features 0 - Backlog Issue is accepted, but is not ready to be worked on or not in current sprint labels Jun 2, 2021
@vexx32 vexx32 added this to the 1.2.x milestone Jun 2, 2021
@pauby pauby modified the milestones: 1.2.x, 1.x.x Jan 21, 2022
@Windos
Copy link
Member

Windos commented Apr 1, 2022

@vexx32 / @pauby - Do you have a preference for how to handle these example playbooks?

  • Include in the README?
  • .yml files in a directory? Where?
  • Something else?

I'll happily work on some (had an interesting one come up just the other day that would be a good example).

@vexx32
Copy link
Member Author

vexx32 commented Apr 1, 2022

Some README examples for simpler things would probably be great, but if you have complete playbooks that we can adapt for the collection as examples or complete playbooks for folks to use, they can go in a playbooks directory alongside the plugins folder I think.

See https://docs.ansible.com/ansible/latest/dev_guide/developing_collections_structure.html#collection-directories-and-files for reference on the general structure.

We can also create a roles folder and fill it with examples / potentially useful roles (e.g., a role for a CCM server or client, perhaps?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0 - Backlog Issue is accepted, but is not ready to be worked on or not in current sprint Documentation Issues for changes that only need to change documentation Improvement Issues that enhances existing functionality, or adds new features
Projects
None yet
Development

No branches or pull requests

3 participants