https://github.com/openstack/security-doc
Documentation work from the OpenStack Security Group (OSSG). Mirror of code maintained at opendev.org.
https://github.com/openstack/security-doc
Last synced: about 1 year ago
JSON representation
Documentation work from the OpenStack Security Group (OSSG). Mirror of code maintained at opendev.org.
- Host: GitHub
- URL: https://github.com/openstack/security-doc
- Owner: openstack
- Created: 2014-05-22T00:51:52.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2025-03-26T13:48:40.000Z (over 1 year ago)
- Last Synced: 2025-03-30T01:10:45.756Z (over 1 year ago)
- Language: Python
- Homepage: https://opendev.org/openstack/security-doc
- Size: 36.9 MB
- Stars: 60
- Watchers: 17
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Security: security-guide/README.rst
Awesome Lists containing this project
README
========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/security-doc.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
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.oftc.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:
`Bugs:openstack-manuals `_
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.