Currently when clicking on the small bug in the roles'
docs, we land on openstack-manuals launchpad.
This should solve it.
Change-Id: I00d33aa1705937813ea8151cc096bc945a6d0428
This patch updates the documentation and the sphinx extension to
write the docs for the RHEL 7 STIG content. The RHEL 7 content
is still hidden for now since it will be under active development
for a while.
Special note:
There are some typos in version 0.2 of the XML for the STIG and those
typos exist in the automatically generated documentation, too.
A new version of the STIG XML is due out very soon which should
correct these.
Implements: bp/security-rhel7-stig
Change-Id: I70dcebdd45ca65e5ae7734c19ee8523fba581e18
This patch adds a workaround for the pickling error that occasionally
causes security role docs builds to fail, which certainly gets us in
a pickle from time to time.
The upstream bug is: sphinx-doc/sphinx#2324
Closes-Bug: 1627732
Change-Id: Iefbb9c920936634d276053d24bc225b2dec44362
With the upcoming changes to rebase onto the RHEL 7 STIG controls,
there needs to be a new solution for documentation that is easier
to manage and filter. This patch automates the generation of the STIG
control documentation in the following way:
* A Sphinx extension runs early in the doc build process that writes
all of the individual STIG control docs as well as ToC pages.
* ToC pages are now sorted by severity, tag, and implementation status.
* A giant listing of controls is easier to navigate now.
* Docs are generated from metadata in the /doc/metadata directory. New
documentation only needs to be added there. (Will explain this in
the developer notes in a subsequent patch.)
Implements: blueprint security-rhel7-stig
Change-Id: I455af1121049f52193e98e2c9cb1ba5d4c292386
This patch uses the new feature in openstackdocstheme 1.5.0
that allows automatic ToC generation to be disabled.
Change-Id: I213d0f934afbc86135ab41c82da91690fb587bb7
This patch updates the sphinx configuration for docs and releasenotes
to make it easier to replicate across repositories and to comply with
pep8 testing without exceptions.
Change-Id: I8381f5e153edbb9dbf22db634728b862ebe4122c
This patch updates the docs for the security role to use the
openstackdocs theme and adds doc8 linting. This matches up with
OpenStack-Ansible's docs changes.
Change-Id: Ie8265bdaf8f8b91454766f5beba14645aabf77cc
This patch removes the ``:orphan:`` docinfo from the documentation
and instead adds the orphaned docs into the ``exclude_pattern``
configuration option. There's a bug that causes the tag to actually
get rendered in the docs when those docs are brought in via an
include.
Change-Id: Iacce8f5bfd9a629117564938bbb376bf5abcec31
This adds a fix to ensure that the published docs have the correct
link to the browsable source code as implemented in
https://review.openstack.org/236091
It also updates the dev-requirements for the docs jobs to ensure
that the requirements are in line with upstream.
It also includes an exclusion of the doc directory from the pep8
check as the documentation conf.py requires a lengthy line.
Change-Id: I7c434b9963391cc89779e90aa24cc4106b4f3534
This role contains around 150 controls from the 270+ controls that exist
in the RHEL 6 STIG. New controls are still being added.
Implements: blueprint security-hardening
Change-Id: I0578f86bf42d55242bc72b97b40a5935a3cb18d6
