Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add security.md to readthedocs #90

Merged
merged 2 commits into from
Dec 6, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ determined time for disclosure has arrived the following will occur:
* An email is sent to the [public cloud-init mailing list](https://lists.launchpad.net/cloud-init/)

The disclosure timeframe is coordinated with the reporter and members of the
cloud-init-security list. This depends on a number of factors:
cloud-init-security list. This depends on a number of factors:

* The reporter might have their own disclosure timeline (e.g. Google Project
Zero and many others use a 90-days after initial report OR when a fix
becomes public)
Expand Down
4 changes: 4 additions & 0 deletions doc-requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
doc8
m2r
sphinx
sphinx_rtd_theme
1 change: 1 addition & 0 deletions doc/rtd/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'm2r',
'sphinx.ext.autodoc',
'sphinx.ext.autosectionlabel',
'sphinx.ext.viewcode',
Expand Down
1 change: 1 addition & 0 deletions doc/rtd/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ Having trouble? We would like to help!
:caption: Development

topics/hacking.rst
topics/security.rst
topics/debugging.rst
topics/logging.rst
topics/dir_layout.rst
Expand Down
5 changes: 5 additions & 0 deletions doc/rtd/topics/security.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.. _security:

.. mdinclude:: ../../../SECURITY.md

.. vi: textwidth=78
4 changes: 1 addition & 3 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,7 @@ exclude = .venv,.tox,dist,doc,*egg,.git,build,tools
[testenv:doc]
basepython = python3
deps =
doc8
sphinx
sphinx_rtd_theme
-r{toxinidir}/doc-requirements.txt
commands =
{envpython} -m sphinx {posargs:doc/rtd doc/rtd_html}
doc8 doc/rtd
Expand Down