diff options
author | 2017-07-19 01:36:52 -0400 | |
---|---|---|
committer | 2017-07-19 17:27:36 +0000 | |
commit | ac93e0eb246a03c02df7a6b7704aaabfdb7461f0 (patch) | |
tree | 493829a3846cacccd492ca30afb6fc6733d47ce7 /docs/templates/release | |
parent | fa0b21e328c982a35de41c5d25127452751a3e6d (diff) |
[DOC-23]Initial structure and Documentation Guide
Change-Id: Ie0fdb7be60acd79b878c2d9b985aaaf6aca035d2
Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/templates/release')
-rw-r--r-- | docs/templates/release/release-notes/index.rst | 11 | ||||
-rw-r--r-- | docs/templates/release/release-notes/release-notes.rst | 27 |
2 files changed, 38 insertions, 0 deletions
diff --git a/docs/templates/release/release-notes/index.rst b/docs/templates/release/release-notes/index.rst new file mode 100644 index 000000000..e703944ef --- /dev/null +++ b/docs/templates/release/release-notes/index.rst @@ -0,0 +1,11 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +**************************** +<Project Name> Release Notes +**************************** + +.. toctree:: + :maxdepth: 1 + + release-notes diff --git a/docs/templates/release/release-notes/release-notes.rst b/docs/templates/release/release-notes/release-notes.rst new file mode 100644 index 000000000..002463d86 --- /dev/null +++ b/docs/templates/release/release-notes/release-notes.rst @@ -0,0 +1,27 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + + +This document provides the release notes for <RELEASE> of <COMPONENT>. + +.. contents:: + :depth: 3 + :local: + + + +Important notes +=============== + +<STATE IMPORTANT NOTES/DEVIATIONS SINCE PREVIOUS ITERATIVE RELEASE AND OTHER IMPORTANT NOTES FOR THIS RELEASE> + +<EXAMPLE>: + + + +Summary +======= + +<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES> + +<EXAMPLE>: + |