This repo contains the source code for theforeman.org. 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!
To test your changes locally use
# bundle exec rake
to generate your site in the _site directory, or
# bundle exec rake server
To start Jekyll server locally.
docker run -it --rm -v `pwd`:/srv/jekyll:Z -p 4000:4000 jekyll/jekyll jekyll serve --watch
Navigate to http://localhost:4000
bundle install
in the root of the freshly cloned repo. This
will install Jekyll, the tool we use to build the site.bundle exec jekyll serve --watch
and open your browser to http://localhost:4000.bundle exec rake new_post['title of my post']
to generate a new empty blog postFor each new release we keep stable documentation tree for the record.
cp -r manuals/nightly manuals/X.Z
cp -r _includes/manuals/nightly manuals/X.Z
scripts/release_notes.rb
scripts/installer/get_params
Follow instructions in the apidocs github repo.