diff options
author | 2017-01-16 16:12:13 +0100 | |
---|---|---|
committer | 2017-01-16 16:12:13 +0100 | |
commit | 7881a0541c8b40663bba4aa3a5efdf9f3421e58f (patch) | |
tree | a48944226bf71a4a93d386d348a1ac6ca42a643a /docs/release/templates/installation | |
parent | 2e90847bdc1ef9ce49eb4c3424690fbb3460818f (diff) |
Adjusted naming path
Adjusted the naming path for consistency throughout our repository and the
community.
Change-Id: Ia055c418584f338f6000835fc28a7e5e8b5c5818
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
Diffstat (limited to 'docs/release/templates/installation')
8 files changed, 119 insertions, 0 deletions
diff --git a/docs/release/templates/installation/<scenario>/<scenario>-installation.rst b/docs/release/templates/installation/<scenario>/<scenario>-installation.rst new file mode 100644 index 000000000..a8cef90ba --- /dev/null +++ b/docs/release/templates/installation/<scenario>/<scenario>-installation.rst @@ -0,0 +1,22 @@ +============================================= +<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 diff --git a/docs/release/templates/installation/<scenario>/<scenario>-postinstallation.rst b/docs/release/templates/installation/<scenario>/<scenario>-postinstallation.rst new file mode 100644 index 000000000..f60537566 --- /dev/null +++ b/docs/release/templates/installation/<scenario>/<scenario>-postinstallation.rst @@ -0,0 +1,17 @@ +================================================= +<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. diff --git a/docs/release/templates/installation/<scenario>/index.rst b/docs/release/templates/installation/<scenario>/index.rst new file mode 100644 index 000000000..053e341d5 --- /dev/null +++ b/docs/release/templates/installation/<scenario>/index.rst @@ -0,0 +1,10 @@ +=================================== +<Scenario> Installation Guide +=================================== + +.. toctree:: + :maxdepth: 2 + + prerequisite + <scenario>-installation + <scenario>-postinstallation
\ No newline at end of file diff --git a/docs/release/templates/installation/abstract.rst b/docs/release/templates/installation/abstract.rst new file mode 100644 index 000000000..4868b1a2a --- /dev/null +++ b/docs/release/templates/installation/abstract.rst @@ -0,0 +1,6 @@ +============================================= +<Project Name> <Release Name> Abstract +============================================= +.. Example, Joid Danube Abstract + +Abstract explaining the Document
\ No newline at end of file diff --git a/docs/release/templates/installation/compatibility.rst b/docs/release/templates/installation/compatibility.rst new file mode 100644 index 000000000..ffed03042 --- /dev/null +++ b/docs/release/templates/installation/compatibility.rst @@ -0,0 +1,18 @@ +============================================== +<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 diff --git a/docs/release/templates/installation/index.rst b/docs/release/templates/installation/index.rst new file mode 100644 index 000000000..032f8d40e --- /dev/null +++ b/docs/release/templates/installation/index.rst @@ -0,0 +1,18 @@ +=================================== +<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 diff --git a/docs/release/templates/installation/prerequisite.rst b/docs/release/templates/installation/prerequisite.rst new file mode 100644 index 000000000..4f8a0069f --- /dev/null +++ b/docs/release/templates/installation/prerequisite.rst @@ -0,0 +1,15 @@ +============================================= +<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 diff --git a/docs/release/templates/installation/supportedscenario.rst b/docs/release/templates/installation/supportedscenario.rst new file mode 100644 index 000000000..3d78911f1 --- /dev/null +++ b/docs/release/templates/installation/supportedscenario.rst @@ -0,0 +1,13 @@ +=================================================== +<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 |