summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorjsseidel <jsseidel@fastmail.com>2017-09-14 14:27:11 -0400
committerjsseidel <jsseidel@fastmail.com>2017-09-14 14:27:11 -0400
commit8a953e2c7005143275c9706775ff0f5eda81df7d (patch)
tree30c40fd0e0fab4e27c38a47479a3278bac409ecc /docs
parent65f78304ac9063f28fc7ae9a8d20e23acfb2aae6 (diff)
Added docs directory and release notes template
Added docs directory and a template for release notes. The template is simply a suggestion. Feel free to remove or add files as needed for whatever makes sense for your project. Change-Id: I2d52479ad210ca57b5a70c0756f90eea3f8e3432 Issue-Id: DOC-47 Signed-off-by: jsseidel <jsseidel@fastmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst6
-rw-r--r--docs/release-notes/bug-fixes.rst5
-rw-r--r--docs/release-notes/deprecation-notes.rst5
-rw-r--r--docs/release-notes/index.rst15
-rw-r--r--docs/release-notes/known-issues.rst5
-rw-r--r--docs/release-notes/new-features.rst5
-rw-r--r--docs/release-notes/other.rst5
-rw-r--r--docs/release-notes/security-issues.rst5
-rw-r--r--docs/release-notes/upgrade-notes.rst5
9 files changed, 56 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..f155d47
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,6 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+.. toctree::
+ :maxdepth: 1
+
+ release-notes/index
diff --git a/docs/release-notes/bug-fixes.rst b/docs/release-notes/bug-fixes.rst
new file mode 100644
index 0000000..ee4ff9f
--- /dev/null
+++ b/docs/release-notes/bug-fixes.rst
@@ -0,0 +1,5 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Bug Fixes
+---------
+
diff --git a/docs/release-notes/deprecation-notes.rst b/docs/release-notes/deprecation-notes.rst
new file mode 100644
index 0000000..e954e87
--- /dev/null
+++ b/docs/release-notes/deprecation-notes.rst
@@ -0,0 +1,5 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Deprecation Notes
+-----------------
+
diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst
new file mode 100644
index 0000000..adc76f9
--- /dev/null
+++ b/docs/release-notes/index.rst
@@ -0,0 +1,15 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Release Notes
+=============
+
+.. toctree::
+ :maxdepth: 2
+
+ new-features.rst
+ bug-fixes.rst
+ known-issues.rst
+ security-issues.rst
+ upgrade-notes.rst
+ deprecation-notes.rst
+ other.rst
diff --git a/docs/release-notes/known-issues.rst b/docs/release-notes/known-issues.rst
new file mode 100644
index 0000000..01c93d1
--- /dev/null
+++ b/docs/release-notes/known-issues.rst
@@ -0,0 +1,5 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Known Issues
+------------
+
diff --git a/docs/release-notes/new-features.rst b/docs/release-notes/new-features.rst
new file mode 100644
index 0000000..ab86bb9
--- /dev/null
+++ b/docs/release-notes/new-features.rst
@@ -0,0 +1,5 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+New Features
+------------
+
diff --git a/docs/release-notes/other.rst b/docs/release-notes/other.rst
new file mode 100644
index 0000000..2ce683b
--- /dev/null
+++ b/docs/release-notes/other.rst
@@ -0,0 +1,5 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Other
+-----
+
diff --git a/docs/release-notes/security-issues.rst b/docs/release-notes/security-issues.rst
new file mode 100644
index 0000000..96e1fe9
--- /dev/null
+++ b/docs/release-notes/security-issues.rst
@@ -0,0 +1,5 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Security Issues
+---------------
+
diff --git a/docs/release-notes/upgrade-notes.rst b/docs/release-notes/upgrade-notes.rst
new file mode 100644
index 0000000..f31c74a
--- /dev/null
+++ b/docs/release-notes/upgrade-notes.rst
@@ -0,0 +1,5 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+Upgrade Notes
+-------------
+