Template updates - sections

[doc.git] / docs / guides / onap-developer / how-to-use-docs / templates / sections / installation.rst

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 be64a63..deac057 100644 (file)
--- 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.