1d5f436400
Switch to openstackdocstheme 2.1.1 version. Using ths version will allow parallelizing building of documents. Update Sphinx version as well. openstackdocstheme renames some variables, so follow the renames. A couple of variables are also not needed anymore, remove them. Set openstackdocs_auto_version to not version the documents. Set openstackdocs_auto_name to use project as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. Remove 0.0.1 version from security-thread-analysis. Change-Id: Idd9c795d97ee33e4f121c5b4b97a9ee9e38ae50e |
||
|---|---|---|
| case-studies | ||
| common | ||
| security-guide | ||
| security-notes | ||
| security-threat-analysis/source | ||
| tools | ||
| .gitignore | ||
| .gitreview | ||
| .zuul.yaml | ||
| README.rst | ||
| bindep.txt | ||
| doc-tools-check-languages.conf | ||
| test-requirements.txt | ||
| tox.ini | ||
README.rst
Team and repository tags
OpenStack Security Documentation
This repository contains the OpenStack Security documentation.
For details on how to contribute to the documentation, see the OpenStack Documentation Contributor Guide.
It includes these manuals:
- Security Guide
- Security Notes
- Security Threat Analysis
The Security Notes are published by the OpenStack Security Project (OSSP) to advise users of security related issues. For more information refer to the Security Notes and Security Note Process.
Security Advisories are issued by the Vulnerability Management Team (VMT). For more information about OpenStack's Vulnerability Management Team (VMT) refer to the Vulnerability Management Process.
Directory Structure
Security Guide is in the directory security-guide, which
source files in RST format in the directory
security-guide/source.
Security Threat Analysis is in the directory
security-threat-analysis, which source files in RST format
in the directory security-threat-analysis/source.
The security notes are in the directory
security-notes.
Testing of changes and building of the guides
Install the python tox package and run tox from the
top-level directory to use the same tests that are done as part of our
Jenkins gating jobs.
tox
Contributing
Our community welcomes all people interested in open source cloud computing, and encourages you to join the OpenStack Foundation.
The best way to get involved with the community is to talk with
others online or at a meet up and offer contributions through our
processes, the OpenStack wiki,
blogs, or on IRC at #openstack on
irc.freenode.net.
We welcome all types of contributions, from blueprint designs to documentation to testing to deployment scripts.
If you would like to contribute to the documents, please see the OpenStack Documentation contributor guide.
Bugs
Bugs should be filed on Launchpad, not GitHub:
If you find a security issue in OpenStack, not in the contents of the Security Guide, please see How to Report Security Issues to OpenStack.
Release Notes
https://docs.openstack.org/releasenotes/openstack-manuals
Installing
Refer to the OpenStack Security Guide to see where these documents are published and to learn more about the OpenStack Security Guide.