Code Monkey home page Code Monkey logo

rudder-api-doc's Introduction

Rudder: configuration management for the masses

This project is part of Rudder - configuration management made easy.

See: http://rudder-project.org for more information.

Authors

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.

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

rudder-api-doc's People

Contributors

fanf avatar jremond avatar vincemacbuche avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.