OpenShift Compliance documentation
This repo has been deprecated. The project has been moved to https://github.com/RedHatGov/openshift-compliance.
For help with ReStructuredText syntax, check out the Quickstart Guide.
This one is good too: Sphinx reST Syntax.
To get started, install Sphinx and the RTD Python modules.
$ sudo pip install Sphinx
$ sudo pip install sphinx_rtd_theme
$ sudo pip install openpyxl
The master security control tracibility matrix (SCTM) is master_sctm.xlsx. It needs to be parsed by master_sctm_parser.py, which generates controls.rst and crm.rst via the security_control.j2 and crm.j2 Jinja2 template.
When you make the html target, this parsing happens automatically. If you want to explicitly parse the template, you can:
$ python master_sctm_parser.py master_sctm.xlsx
Spreadsheet warnings:
- Do not edit this spreadsheet with LibreOffice Calc. It will break the spreadhseet and make it unparseable by
openpyxl. - The spreadsheet is filtered by FISMA High controls. If you change the filters the resultant .rst file will be different, too.
Once you have made changes to your docs, commit your changes. You can build the docs to view locally.
$ git add -A
$ git commit -am 'my commit message'
$ make html
Sanity check the output for errors. The docs can be viewed in the _biuld/html directory.
For the time being, this project is being distributed via Read the Docs
The main page is at http://openshift-compliance-guide.readthedocs.io.