Git Product home page Git Product logo

apidocs's Introduction

Foreman API documentation

Generated HTML API documentation for the Foreman and its plugins via apipie-rails.

The content is hosted at https://apidocs.theforeman.org

For Foreman documentation go to https://docs.theforeman.org

Adding new version

Follow these steps to add a new version:

Foreman

Generate API docs in Foreman:

  1. cd to foreman directory and checkout the relevant stable branch
  2. disable any plugins installed locally
  3. APIPIE_RECORD=examples rake test
  4. FOREMAN_APIPIE_LANGS=en rake apipie:cache

Prepare folder for the new version (X.Y)

  1. cd to foreman directory
  2. cp -r TEMPLATE X.Y
  3. unlink latest; ln -s X.Y latest
  4. cp -r dir/to/foreman/public/apipie-cache/apidoc/* Y.Y/apidoc
  5. run cleanup script in apidoc repo: cleanup.sh
  6. update index.html file with a link to the new page

LICENSE

All files are auto-generated and distributed under GNU GPL v3 conditions. See the LICENSE file for more info.

apidocs's People

Watchers

 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.