galaxy and playbooks

I’m putting some finishing touches on a number of riak related roles. Since riak is a distributed system, these roles really don’t shine unless they are used on a number of hosts. I’d like to provide some example playbooks with the roles that show how to do this, but it seems there is no convention other than placing examples in the readme. Is it alright to include an examples directory for playbooks & inventory?

  • James

It will be included in the tarball that is downloaded from github, but I think the correct place to show at least some examples would be in the README, as that’s what most people will see. You can include documentation there to show that there are more complex example playbooks in the examples directory though, which is a good idea.