Skip to content

README.md

Latest commit

 

History

History
118 lines (80 loc) · 6.09 KB

README.md

File metadata and controls

118 lines (80 loc) · 6.09 KB

🤝 Community & Contributing

Come for the automation, stay for the people.

The OpenVox Community

OpenVox exists because of its community. Born from the Vox Pupuli collective — a group of Puppet module maintainers who've been collaborating for years — OpenVox carries forward the tradition of open-source infrastructure management.

Key Community Resources

Resource URL Purpose
OpenVox GitHub github.com/openvoxproject Source code, issues, PRs
Vox Pupuli voxpupuli.org Community hub, blog, docs
VoxPupuli Community Slack voxpupuli.slack.com VoxPupuli & OpenVox real-time chat
Puppet Community Slack puppetcommunity.slack.com Broader Puppet ecosystem chat
VoxPupuli Connect voxpupuli.org/connect All VoxPupuli & OpenVox community links
Puppet Forge forge.puppet.com Module repository
Vox Pupuli Blog voxpupuli.org/blog Release announcements, articles

Where to Ask Questions

  1. VoxPupuli Community Slack — The home turf for OpenVox and Vox Pupuli discussion. Join at voxpupuli.slack.com.
  2. Puppet Community Slack — The broader Puppet ecosystem. The #openvox and #voxpupuli channels are great places to start.
  3. GitHub Issues — For bug reports, feature requests, and technical discussions on specific repos.
  4. Stack Overflow — Tag your questions with puppet and openvox.
  5. VoxPupuli Connect — A single page with links to all community channels, mailing lists, and social media: voxpupuli.org/connect.

How to Contribute

Reporting Bugs

Found a bug? Awesome (well, not awesome for you, but we appreciate the report). Here's how:

  1. Search first — check existing issues on the relevant GitHub repo
  2. Create an issue with:
    • OpenVox/Puppet version (puppet --version)
    • OS and version (facter os.release.full)
    • Steps to reproduce
    • Expected vs. actual behavior
    • Relevant log output (from puppet agent -t --debug or server logs)

Contributing Code

  1. Fork the repository on GitHub
  2. Create a branch for your change (git checkout -b fix/ssl-error-handling)
  3. Write tests for your change
  4. Follow the style of the existing codebase
  5. Submit a pull request with a clear description

Contributing Modules

The Puppet Forge welcomes modules from anyone! If you've built something useful:

  1. Follow the Module Development Guide
  2. Include tests (rspec-puppet at minimum)
  3. Write a clear README with usage examples
  4. Publish to the Forge

Contributing to These Docs

This documentation lives at github.com/cvquesty/voxdocs and is referenced by the official OpenVox documentation project at github.com/OpenVoxProject/openvox-docs. Contributions are welcome! Fix a typo, improve an explanation, add an example — every bit helps.

Related Projects

The Puppet/OpenVox ecosystem is vast. Here are some projects worth knowing about:

Project Description Link
Puppet Forge Community module repository forge.puppet.com
puppet-lint Original Puppet linter github.com/puppetlabs/puppet-lint
rspec-puppet Unit testing for Puppet github.com/puppetlabs/rspec-puppet
Litmus Acceptance testing framework github.com/puppetlabs/puppet_litmus
puppetboard PuppetDB web frontend github.com/voxpupuli/puppetboard
openvox-gui Web-based management GUI for OpenVox github.com/cvquesty/openvox-gui
openvox-lint Puppet manifest linter (modernized puppet-lint) rubygems.org/gems/openvox-lint

Conferences and Events

  • VoxConf — Vox Pupuli's community conference (voxpupuli.org/voxconf)
  • Config Management Camp — Annual configuration management conference in Ghent, Belgium
  • PuppetCamp — Regional community meetups

Code of Conduct

The OpenVox and Vox Pupuli communities are committed to providing a welcoming, inclusive environment for everyone. Be kind, be respectful, and be constructive. We're all here because we love automating things and occasionally complaining about YAML indentation.

Acknowledgments

This project stands on the shoulders of giants:

  • Puppet Labs (now Perforce) — for creating the original Puppet platform and open-sourcing it
  • Overlook InfraTech — for stepping up with community packaging when Perforce discontinued public distribution of open-source Puppet in late 2024, keeping the ecosystem alive while the community organized
  • Vox Pupuli — for adopting the project, renaming it OpenVox, and continuing to maintain hundreds of community modules
  • The Puppet Standards Steering Committee — for guiding language and feature evolution across the broader Puppet ecosystem
  • The docs-archive — for preserving the legacy Puppet documentation
  • betadots GmbH — for sponsoring OpenVox development
  • The entire Puppet community — decades of contributions, modules, blog posts, and Stack Overflow answers

And of course, thanks to you for reading this far. Now go automate something! 🦊

You've reached the end of the docs. Go back to the Documentation Map or start managing some infrastructure!

This document was created with the assistance of AI (Grok, xAI). All technical content has been reviewed and verified by human contributors.