The Qovery team loves its documentation, and if you help write it, it loves you too.
Want to help the community and get great rewards at the same time? Contribute to Qovery documentation! Qovery Community plan is charged by contributions to the community - you can get free credits to host your applications by contributing in many ways - including by writing or fixing the docs!
Learn more about our reward system:
- Qovery's documentation is located in the website/docs folder.
- If a file contains an "AUTOGENERATED" warning at the top, do not modify the file directly. Instead modify the referenced template.
- Reference documents (website/docs/reference) are generated automatically using specs found in .meta.
- Run
make generateto re-generate files.
The documentation site is built using Docusaurus and can be found in the website folder. You can read more about how it works and how to run it locally in the README.
Qovery documentation is mostly generated using Ruby, where the scripts can be found within the scripts folder. You can read more about these scripts in the README.