diff options
| author |   thmsdt <thomas.kulik@telekom.de> | 2022-08-02 13:28:17 +0200 |
|---|---|---|
| committer | thmsdt <thomas.kulik@telekom.de> | 2022-08-04 11:51:51 +0200 |
| commit | 21d59414fca273aade30aa4209aca9bb35a5f78f (patch) | |
| tree | bd1a7449fddb04204f3c759b2877b49f92fe6a17 /docs/guides/onap-documentation/templates/sections/installation.rst | |
| parent | 830bc298c26764f3d98f3ca98adf7b3c1b3d0a3a (diff) | |
update and rearrange documentation related content
Issue-ID: DOC-798
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Id454ec5f09903efb81123669e6eb024f21a08797
Diffstat (limited to 'docs/guides/onap-documentation/templates/sections/installation.rst')
| -rw-r--r-- | docs/guides/onap-documentation/templates/sections/installation.rst | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/docs/guides/onap-documentation/templates/sections/installation.rst b/docs/guides/onap-documentation/templates/sections/installation.rst new file mode 100644 index 000000000..deac057b1 --- /dev/null +++ b/docs/guides/onap-documentation/templates/sections/installation.rst @@ -0,0 +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 +============ + +.. + * This section is used to describe how a software component is delivered and + installed. + + * 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 ++++++++++++++++++++++++++++ + +.. + Include both generic troubleshooting steps and ones specific to the upgrade + steps. |