README
¶
TODO
Check the following wiki page for instructions how to setup everything needed to open source the project. Once you're done, make sure to delete this TODO part.
Overview
TODO
Installation
We strongly recommend that you use an official release of XXX. The tarballs for each release contain the command-line client and version-specific sample YAML files for deploying XXX to your cluster. Follow the instructions under the Install section of our documentation to get started.
The code and sample YAML files in the master branch of the XXX repository are under active development and are not guaranteed to be stable. Use them at your own risk!
More information
The documentation provides a getting started guide, plus information about building from source, architecture, extending XXX, and more.
Please use the version selector at the top of the site to ensure you are using the appropriate documentation for your version of XXX.
Troubleshooting
If you encounter issues file an issue or talk to us on the #XXX channel on the Kubermatic Slack.
Contributing
Thanks for taking the time to join our community and start contributing!
Feedback and discussion are available on the mailing list.
Before you start
- Please familiarize yourself with the Code of Conduct before contributing.
- See CONTRIBUTING.md for instructions on the developer certificate of origin that we require.
- Read how we're using ZenHub for project and roadmap planning
Pull requests
- We welcome pull requests. Feel free to dig through the issues and jump in.
Changelog
See the list of releases to find out about feature changes.
Directories