Repository files navigation

The https://voxpupuli.org site. Have a look at it to seewhat this is all about.

• Table of Contents
• Building this site
• Puppet Plugins
  • Tool definition format
    • Tool Schema
    • Plugin Schema
  • What's a tool vs. a plugin
• Contribution
• Writing docs
• License

• bundle install
• bundle exec jekyll serve -w --config _config.yml,_config-dev.yml

You can also use the rake tasks defined in theRakefile:

• build:jekyll build
• validate: uses html-proofer to check the generated site
• clean: removes the./_site directory Jekyll generated

Tools and plugins that appear on the Plugins page of our siteare defined in the_data/tools directory. Tools without plugins are going tobe listed in the table under theTools header. Tools with plugins will havetheir own header and table listing the plugins defined for that tool.

There's a single hash in each tool's definition that describes the tool andoptionally contains an array of plugins that can be used with that tool. A toolthat doesn't have any plugins will be listed in the table under the Tools headerwhile a tool that does have plugins will have its own header and a table listingall plugins in the tool'splugins array.

The difference can be kind of fluid, so I figured it would be helpful to defineplugin and tool.

Aplugin cannot generally be used independent of another tool. Plugins addfunctionality to another tool. An example of a plugin isbeaker-libvirtbecause it enables libvirt as a hypervisor in Beaker.

Atool can generally be used independent of another specific tool or it is atool that has plugins itself. An example of a tool isrspec-puppet because ithas plugins. Another example of a tool ismodulesync because it can be usedindependent of another tool.

We happily accept contributions of all kind. Did you spot a typo somewhere? Didyou do a talk about Vox Pupuli that you would like to link to? Do you want towrite a plog post?

Feel free to send us a pull request with your changes or raise anissue.We currently require all commits in this repo to be signed with gpg, soplease configure your git client properly. Let us know if you need some help. We're alsoreachable via our IRC channel #voxpupuli onLibera.Chat (webchat)and#voxpupuli on thePuppet Community Slack.

We test if the pages still build properly via travis, You can run this locallyby runningbundle exec rake test.

Docs can have the following header:

---layout: posttitle: Deprecated and Archived Modulesdate: 2019-11-29summary: Vox Pupuli policy on deprecating and archiving modulesgithub_username: binford2klast_updater: bastelfreak---

• title will be used in the URL + in the header
• date is assumed as the date of publishing
• summary is a short roundup used on the navigation page
• github_username the GitHub username of the original author, optional attribute
• last_update the GitHub username of the author from the last update, optional attribute (if it was updated is determined by Jekyll automatically)

Our website uses two licenses. The actual content usesCC BY-SA 4.0. This is thesame license as ourlogosuse. The underlying scripts and code of our website use theApache-2 license. TheApache-2 and theCC BY-SA 4.0 files are present in therepository.