Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 1.72 KB

README.md

File metadata and controls

53 lines (36 loc) · 1.72 KB
Raw

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 bundle exec rake test
  4. FOREMAN_APIPIE_LANGS=en bundle exec rake apipie:cache

Prepare folder for the new version (X.Y)

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

Katello

Generate API docs in a Foreman + Katello development environment:

  1. cd to the katello directory and checkout the relevant release branch
  2. cd to the foreman directory and checkout the relevant stable branch
  3. APIPIE_RECORD=examples bundle exec rake test
  4. RAILS_ENV=production FOREMAN_APIPIE_LANGS=en bundle exec rake apipie:cache

Prepare folder for the new version (X.Y)

  1. cd to the apidocs/katello directory
  2. cp -r TEMPLATE X.Y
  3. ln -snf X.Y latest
  4. cp -r dir/to/foreman/public/apipie-cache/apidoc/* X.Y/apidoc
  5. run cleanup script in apidocs 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.