The new and improved Foreman website.
HTML Other
Latest commit 3f07648 Mar 19, 2017 @rahulbajaj0509 rahulbajaj0509 committed with mmoll Clean up HTML leftovers in old blogposts
closes GH-467
closes GH-831
Failed to load latest commit information.
_data events: add 2017-03-30 demo Mar 23, 2017
_includes Revert "Add survey to frontpage " - survey is now closed Mar 16, 2017
_layouts Fix the return button functionality in blog posts Mar 21, 2017
_plugins Use off-by-one date fix for ICS generation too Apr 14, 2016
_posts Clean up HTML leftovers in old blogposts Mar 24, 2017
api Add generated 1.14 API docs Jan 13, 2017
blog Make Guest Posts reposted from community authors stand out easily Nov 6, 2015
events events: Add 3 more events and remove birthday paragraph Sep 26, 2016
manuals Copy 1.14 manual to 1.15 Mar 10, 2017
plugins Add openscap doc for report downloads and running scans from UI (#829) Mar 16, 2017
scripts Add 1.14 contributors Dec 22, 2016
slides Copy-editing to improve readability Apr 10, 2014
static blog: February newsletter Feb 28, 2017
.gitignore Update website gems to new GitHub Pages stack Oct 13, 2015
Gemfile Update version of github-pages gem to 104 Nov 15, 2016
LICENSE Explicitly license content under Creative Commons Attribution-ShareAl… Mar 1, 2013 Add generated 1.12 API docs Jun 15, 2016
Rakefile Added Discovery via HTTP blog post Nov 27, 2015
_config.yml Release 1.14.0 Jan 16, 2017 Redirect old /api pages Sep 8, 2015 Redirect old /api pages Sep 8, 2015 Remove mention of master branch, only use develop Feb 18, 2017 Copy 1.14 manual to 1.15 Mar 10, 2017
favicon.ico carusel for screenshots, tocify for manuals. Jan 9, 2013 Add deprecation to js guidelines and correct lint command Feb 2, 2017
index.html visual changes to the landing page Feb 3, 2014 Updates to introduction page (#668) Jul 19, 2016 Changed videos to media and added new articles Sep 23, 2014 Mark Foreman-as-a-service project as needing a new mentor Oct 28, 2015 Added CVE-2016-9593 Mar 8, 2017 Add Stephen Wood to sponsors list Nov 13, 2015 Expand IRC guidelines to cover other communication, and add note on r… Oct 5, 2016 training: add landing page, netways foreman course, and a blog post May 9, 2016

This repo contains the source code for All of the site's content is written in Markdown. If you're not familiar with it, fear not; it's easy to learn and to become rapidly productive!

Everything you push into the gh-pages branch goes live immediately!

Testing locally

To test your changes locally use

# rake

to generate your site in the _site directory, or

# rake server

To start Jekyll server locally.


  1. Fork this repo to your account.
  2. Clone the fork.
  3. Run bundle install in the root of the freshly cloned repo. This will install Jekyll, the tool we use to build the site.
  4. Run jekyll serve --watch and open your browser to http://localhost:4000.
  5. Make some changes, refresh your browser to preview them.
  6. Submit a pull request.

Contributing a blog post

  1. (following on from step 5 above)
  2. Run rake new_post['title of my post'] to generate a new empty blog post
  3. Edit _posts/
  4. Set the author correctly, and appropriate tags (see previous posts for examples)
  5. Add content, and preview as above.
  6. Submit PR

New release actions

For each new release we keep stable documentation tree for the record.

Foreman Core

  1. cp -r manuals/X.Y manuals/X.Z
  2. change version numbers in manuals/1.10/*.md
  3. add version to

Foreman Plugins

  1. cp -r plugins/foreman_plugin/X.Y plugins/foreman_plugin/X.Z
  2. add "warning: old" to plugins/foreman_plugin/X.Y/
  3. update plugins/foreman_plugin/

Updating API Auto-Generated Docs by apipie

Generate API docs in Foreman

  1. cd to foreman directory
  2. APIPIE_RECORD=examples rake test
  3. rake apipie:cache

Prepare folder for the new version (X.Y)

  1. cd to directory
  2. cp -r new_version_template X.Y
  3. edit file X.Y/ and set correct version

Copy docs to repo

  1. cp -r dir/to/foreman/public/apipie-cache/apidoc/* Y.Y/apidoc
  2. find Y.Y -name *.json -delete