This git repository contains the following documentation:
For official Foreman documentation, see Foreman Manual.
Contributions are welcome. Please, familiarize yourself with CONTRIBUTING and Contribution Guidelines for Foreman guides.
This is a tree of documentation based on Red Hat Satellite 6 official books.
See README in the guides/
subdirectory for more information.
The landing page for docs.theforeman.org is available as a generated static site.
The static content is always built from the master
branch.
See README in the web/
subdirectory for more information.
To build both static site and guides for easy local testing, there is the global Makefile
in the root directory with the following targets:
html
: builds HTML guides with all contexts (foreman-el
, foreman-deb
, katello
, satellite
, and orcharhino
)web
: builds static site using the nanoc
toolcompile
: compiles all content into a single directory ./result
serve
: serves the result directory via a python web server (the default target)To test the whole site locally, perform make serve
command and open up http://localhost:5000
.
Use PORT=5008
to change the web server port (5000 by default).
It builds all contexts so the initial build can be slow, make sure to use -j
option for faster builds on modern multi-core machines.
Stable versions are symlink to the nightly (current) version, this can cause issues for deleted (or renamed) guides.
Github actions perform HTML (with link validation) and WEB artifact creation and if succeeded and branch is master or stable, artifacts are downloaded, extracted and deployed (commited into gh-pages). Deployment does not delete files, in order to remove some unwanted content, manual deletion and push into gh-pages must be performed.
When a commit is pushed into master
:
/
or /nightly
respectively.gh-pages
branch.When a commit is pushed into X.Y
:
/X.Y
.gh-pages
branch.master
, pull the latest changes and create a new X.Y
branch.X.Y
:
guides/common/attributes.adoc
.DocState
to unsupported
.ProjectVersion
to X.Y
and set the matching KatelloVersion
.X.Y
branch.master
:
ProjectVersionPrevious
to X.Y
in guides/common/attributes.adoc
.X.Y.json
and edit it accordingly.state
to RC
.katello
to the right version.Nightly
in titles to the appropriate version.X.Y.adoc
and edit it accordingly. Remove guides which aren't ready for stable branches.VERSION_LINKS
in the root Makefile
.master
./X.Y
.See LICENSE files in individual subdirectories.