Rudder: configuration management for the masses
This project is part of Rudder - configuration management made easy.
See: http://rudder-project.org for more information.
| Screenshots | |
| User documentation | |
| Bug report |
http://www.rudder-project.org/redmine/projects/rudder/issues |
| Mailing list, irc |
License
This project is licensed under AGPLv3 license, see the provided "LICENSE" file or http://www.gnu.org/licenses/agpl-3.0.txt
Contributing
Thank you for your interest in our project! The contribution process is detailed here: http://www.rudder-project.org/HowToContribute
Synopsis
This project allows to build the documentation for the REST API of Rudder.
It is published on http://www.rudder-project.org/rudder-api-doc/
Usage
If you are interested about using Rudder REST API, you should simply look at the generated documentation.
The project is the one that manage the REST API web site creation. It is based on APIDoc (http://apidocjs.com).
The build needs NodeJS and npm, see: http://apidocjs.com/#install
To build the whole things, once nodeje is installed, just execute the build.sh script
Template update
To update the template from a new version of apidoc you need to get all of the new ${APIDOC_DIRECTORY}/template directory content except : - vendor/bootstrap.* that must be taken from this repository - index.html that has been modified localy
index.html just has a slight modification located between 2 comments "XXX Local modifications XXX"