summaryrefslogtreecommitdiffstats
path: root/docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst
diff options
context:
space:
mode:
authorAndrea Visnyei <andrea.visnyei@nokia.com>2020-12-09 12:26:35 +0100
committerEric Debeau <eric.debeau@orange.com>2021-05-06 15:36:12 +0200
commit32d2daf4c1c9a01c6cc6e9b4218b9f4d2650b8e8 (patch)
tree037bd4cf5220935b9f405d3db64e9b5b5e01eafe /docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst
parentc7d15886be96f3036709bb0acc4beb7169e8eec1 (diff)
Template updates - sections
Instructions and examples added, notes commented out, review comments implemented Add example.com in the linkcheck_ignore Issue-ID: DOC-696 Change-Id: I8221ba6f2adce534ced7d8c06fbc7f23eef39efe Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
Diffstat (limited to 'docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst')
-rw-r--r--docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst69
1 files changed, 61 insertions, 8 deletions
diff --git a/docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst b/docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst
index be64a63bb..deac057b1 100644
--- a/docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst
+++ b/docs/guides/onap-developer/how-to-use-docs/templates/sections/installation.rst
@@ -1,20 +1,73 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
+.. Copyright 2021 ONAP contributors, Nokia
Installation
============
-.. note::
- * This section is used to describe how a software component is acquired and installed.
-
- * This section is typically: provided for a platform-component and application; and
- referenced in user guides.
+..
+ * This section is used to describe how a software component is delivered and
+ installed.
- * This note must be removed after content has been added.
+ * This section is typically: provided for a platform-component and
+ application; and referenced in user guides.
+
+Preparations
+------------
+
+..
+ e.g. The software must be delivered as described in section Delivery.
Environment
-----------
+..
+ Cloud containers, public cloud, image formats, resource needs.
+
+Installation
+------------
+
+Procedure
++++++++++
+
+#. Start the installation.
+
+..
+ Include screenshots or specific commands as examples wherever possible.
+ Add the expected result, as well.
+
+#. Verify the installation.
+
+Troubleshooting the installation
+++++++++++++++++++++++++++++++++
+
+..
+ Include both generic troubleshooting steps and ones specific to the
+ installation steps.
+
+Upgrade
+-------
+
+..
+ If there are any dependencies, mention them here.
+ Check compatibility between API versions.
+
+Procedure
++++++++++
+
+#. (optional) Backup your data before starting the upgrade.
+
+..
+ Either list the backup steps here or refer to a backup and restore guide (if
+ it exists).
+
+#. Start the upgrade.
+
+#. Verify the success of the upgrade.
+
+Troubleshooting the upgrade
++++++++++++++++++++++++++++
-Steps
------
+..
+ Include both generic troubleshooting steps and ones specific to the upgrade
+ steps.