--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+=====================
+<feature> Design
+=====================
+
+.. describe which upstream components (e.g. OpenStack modules, ..) are working together to provide the functionality
+.. describe some deployment architecture
+.. fill the gap between the release notes and the detailed documentation provided by the participating projects or upstream communities
+
+.. toctree::
+ :maxdepth: 2
+
+ ./design.rst
+
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+======================
+<feature> Integration
+======================
+
+Introduction
+==============
+..Brief on what scenario's the project can be integrated to.
+
+Integration Steps for <>
+===========================
+.. List steps to integrate <project> with <scenario>
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+===================================
+<scenario> Overview and Description
+===================================
+.. This document will be used to provide a description of the scenario for an end user.
+.. You should explain the purpose of the scenario, the types of capabilities provided and
+.. the unique components that make up the scenario including how they are used.
+
+.. toctree::
+ :maxdepth: 3
+
+ ./scenario.description.rst
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+Introduction
+============
+.. In this section explain the purpose of the scenario and the types of capabilities provided
+
+Scenario components and composition
+===================================
+.. In this section describe the unique components that make up the scenario,
+.. what each component provides and why it has been included in order
+.. to communicate to the user the capabilities available in this scenario.
+
+Scenario usage overview
+=======================
+.. Provide a brief overview on how to use the scenario and the features available to the
+.. user. This should be an "introduction" to the userguide document, and explicitly link to it,
+.. where the specifics of the features are covered including examples and API's
+
+Limitations, Issues and Workarounds
+===================================
+.. Explain scenario limitations here, this should be at a design level rather than discussing
+.. faults or bugs. If the system design only provide some expected functionality then provide
+.. some insight at this point.
+
+References
+==========
+
+For more information on the OPNFV Danube release, please visit
+http://www.opnfv.org/danube
--- /dev/null
+=============================================
+<Project Name> <Release Name> Installation
+=============================================
+
+
+Preparing for Installation
+=====================================
+Include any pre configuration, database, or other software downloads
+required to install <project>.
+
+Installing <Feature>
+====================================
+Installation toolkit
+
+Verifying your Installation
+====================================
+Describe how to verify the installation.
+
+Troubleshooting
+====================================
+<optional>
+Text goes here.
\ No newline at end of file
--- /dev/null
+=================================================
+<Project Name> <Release Name> Post Installation
+=================================================
+
+
+Post Installation Configuration
+=====================================
+Post Installation Configuration section must include some basic
+(must-do) procedures if any, to get started.
+
+Upgrading From <a Previous Release>
+====================================
+Text goes here.
+
+?Uninstalling? <Feature>
+====================================
+Text here.
--- /dev/null
+===================================
+<Scenario> Installation Guide
+===================================
+
+.. toctree::
+ :maxdepth: 2
+
+ prerequisite
+ <scenario>-installation
+ <scenario>-postinstallation
\ No newline at end of file
--- /dev/null
+=============================================
+<Project Name> <Release Name> Abstract
+=============================================
+.. Example, Joid Danube Abstract
+
+Abstract explaining the Document
\ No newline at end of file
--- /dev/null
+==============================================
+<Project Name> <Release Name> Compatibility
+==============================================
+
+
+Compatibility with Previous Releases
+=======================================
+<optional, required if there's a previous release>
+Is it compatible? Did anything about how a user or developer would
+consume it change? If so, document it here.
+
+Migration from Previous Releases
+=====================================
+<optional, required if there's a previous release for the project>
+
+Describe any special step somebody would have to take to migrate from a
+previous release to this one. If migration isn't supported for some
+combinations, state that as well.
\ No newline at end of file
--- /dev/null
+===================================
+<Project Name> Installation Guide
+===================================
+
+Installation Guide
+===================
+Refer to https://wiki.opnfv.org/display/DOC/Installation+procedure
+Naming Convention is: <Name> <Use Case> <file name>. Eg: Apex Installation Guide Abstract
+
+.. toctree::
+ :maxdepth: 2
+
+ abstract
+ prerequisite
+ supportedscenario
+ <scenario>/index
+ compatibility
+ references
\ No newline at end of file
--- /dev/null
+=============================================
+<Project Name> <Release Name> Prerequisite
+=============================================
+
+
+Hardware requirement
+=====================================
+List out the HW requirements
+
+Software requirement
+====================================
+List out the SW requirements
+
+Configurations
+====================================
\ No newline at end of file
--- /dev/null
+===================================================
+<Project Name> <Release Name> Supported Scenarios
+===================================================
+
+<Brief>
+=========
+Add a short brief about supported scenarios
+
+.. toctree::
+ :maxdepth: 2
+
+ development/<scenario1>/index
+ development/<scenario2>/index
\ No newline at end of file
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
+=============================================
+<Project Name> <Release Name> Overview
+=============================================
+
+For example, the title might be "Qtip Danube Overview"
+
+<Brief (Optional)>
+===================
+
+.. toctree::
+ :maxdepth: 2
+
+ overview
--- /dev/null
+==============================================
+<Project Name> <Release Name> Overview
+==============================================
+
+
+Introduction
+=======================================
+Describing the components and behaviours in a manner that helps people understand the platform and how to work with it
+
+Upgrades from <Previous Release>
+=====================================
+<optional, required if there's a previous release for the project>
+Describe the new features
\ No newline at end of file
--- /dev/null
+=============================================
+<Project Name> <Release Name> Bugs
+=============================================
+
+
+Resolved Bugs
+===============
+List open and resolved bugs if any.
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-86 | Need ability to specify number of |
+| | compute nodes |
++--------------------------------------+--------------------------------------+
+
+Deprecated and Removed Capabilities
+=====================================
+Provide information about the capabilities that are removed or
+deprecated in this release.
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-86 | Need ability to specify number of |
+| | compute nodes |
++--------------------------------------+--------------------------------------+
+
+Known Limitations
+=====================================
+Provide information about the capabilities that are removed or
+deprecated in this release.
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-86 | Need ability to specify number of |
+| | compute nodes |
++--------------------------------------+--------------------------------------+
+
+Open Bugs
+=====================================
+List any remaining open bugs. Ideally provide a short description and a
+link to the entry in JIRA
+
+**JIRA TICKETS:**
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: APEX-86 | Need ability to specify number of |
+| | compute nodes |
++--------------------------------------+--------------------------------------+
\ No newline at end of file
--- /dev/null
+==============================================
+<Project Name> <Release Name> Compatibility
+==============================================
+
+
+Compatibility with Previous Releases
+=======================================
+<optional, required if there's a previous release>
+Is it compatible? Did anything about how a user or developer would
+consume it change? If so, document it here.
+
+Migration from Previous Releases
+=====================================
+<optional, required if there's a previous release for the project>
+
+Describe any special step somebody would have to take to migrate from a
+previous release to this one. If migration isn't supported for some
+combinations, state that as well.
\ No newline at end of file
--- /dev/null
+==============================================
+<Project Name> <Release Name> Deliverables
+==============================================
+
+
+Software Deliverables
+=======================================
+List out the software deliverables
+
+Documentation Deliverables
+=====================================
+Call out the documentation deliverables
\ No newline at end of file
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
+=============================================
+<Project Name> <Release Name> Release Notes
+=============================================
+
+Abstract
+===================
+Preface to what this document is about
+
+License
+=======
+Include Licensing information here
+
+Version History
+===============
+
+
++-------------+-----------+-----------------+----------------------+
+| **Date** | **Ver.** | **Authors** | **Comment** |
+| | | | |
++-------------+-----------+-----------------+----------------------+
+| YYYY-MM-DD | X.X.X | Name | Comments |
++-------------+-----------+-----------------+----------------------+
+| YYYY-MM-DD | X.X.X | Name | Comments |+-------------+-----------+-----------------+----------------------+
+| YYYY-MM-DD | X.X.X | Name | Comments |
++-------------+-----------+-----------------+----------------------+
+
+Contents
+===============
+
+.. toctree::
+ :maxdepth: 2
+
+ summary
+ version
+ compatibility
+ bugs
+ deliverables
+ scenario/index
+ references
--- /dev/null
+=============================================
+<Project Name> <Release Name> New Features
+=============================================
+
+
+Major Capabilities and Enhancements
+=====================================
+Provide information about the major capabilities this project provides
+in this release. Include those from previous release unless they have
+been deprecated or removed (see below).
+
+New Capabilities and Enhancements
+====================================
+Call out the new capabilities and/or enhancements that are present in
+this release, but were not present in prior releases.
+
+
++--------------------------------------+--------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+--------------------------------------+
+| JIRA: <XXXXXX> | Brief here |
++--------------------------------------+--------------------------------------+
--- /dev/null
+==============================================
+<Project Name> <Release Name> References
+==============================================
+
+List references
\ No newline at end of file
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+
+=============================================
+<Scenario> <Release Name> Release Notes
+=============================================
+
+
+Introduction
+============
+.. In this section explain the purpose of the scenario and the types of capabilities provided
+
+Scenario components and composition
+===================================
+.. In this section describe the unique components that make up the scenario,
+.. what each component provides and why it has been included in order
+.. to communicate to the user the capabilities available in this scenario.
+
+Scenario usage overview
+=======================
+.. Provide a brief overview on how to use the scenario and the features available to the
+.. user. This should be an "introduction" to the userguide document, and explicitly link to it,
+.. where the specifics of the features are covered including examples and API's
+
+Limitations, Issues and Workarounds
+===================================
+.. Explain scenario limitations here, this should be at a design level rather than discussing
+.. faults or bugs. If the system design only provide some expected functionality then provide
+.. some insight at this point.
+
+References
+==========
+
+For more information on the OPNFV Colorado release, please visit
+http://www.opnfv.org/colorado
\ No newline at end of file
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) OPNFV, Ericsson AB and others.
+
+=============================================
+<Release Name> Scenario Release Notes
+=============================================
+
+<Brief (Optional)>
+===================
+
+.. toctree::
+ :maxdepth: 2
+
+ <scenarioname>
--- /dev/null
+==============================================
+<Project Name> <Release Name> Version
+==============================================
+
+
+Module version changes
+========================
+List module level version changes
+
+
+Document Version Changes
+==========================
+Changes in documentation
\ No newline at end of file
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+<Feature> description
+=====================
+.. Describe the specific features and how it is realised in the scenario in a brief manner
+.. to ensure the user understand the context for the user guide instructions to follow.
+
+<Feature> capabilities and usage
+================================
+.. Describe the specific capabilities and usage for <XYZ> feature.
+.. Provide enough information that a user will be able to operate the feature on a deployed scenario.
+
+<Feature and API usage guidelines and example>
+-----------------------------------------------
+.. Describe with examples how to use specific features, provide API examples and details required to
+.. operate the feature on the platform.
--- /dev/null
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) <optionally add copywriters name>
+
+=====================
+<feature> User Guide
+=====================
+
+.. The feature user guide should provide an OPNFV user with enough information to
+.. use the features provided by the feature project in the supported scenarios.
+.. This guide should walk a user through the usage of the features once a scenario
+.. has been deployed and is active according to the installation guide provided
+.. by the installer project.
+
+.. toctree::
+ :maxdepth: 2
+
+.. The feature.userguide.rst file should contain the text for this document
+.. additional documents can be added to this directory and added in the right order
+.. to this file as a list below.
+
+ ./feature.userguide.rst
+
Code Review / opnfvdocs.git / commitdiff