Merge "New docs for 'How to include documentation'"
[opnfvdocs.git] / docs / templates / release / configguide / postinstall.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 =======================================
5 <Project> Post Installation Procedure
6 =======================================
7
8 Add a brief introduction to the methods of validating the installation
9 according to this specific installer or feature.
10
11 .. contents::
12    :depth: 3
13    :local:
14
15 Automated post installation activities
16 ----------------------------------------
17 Describe specific post installation activities performed by the OPNFV
18 deployment pipeline including testing activities and reports. Refer to
19 the relevant testing guides, results, and release notes.
20
21 note: this section should be singular and derived from the test projects
22 once we have one test suite to run for all deploy tools.  This is not the
23 case yet so each deploy tool will need to provide (hopefully very simillar)
24 documentation of this.
25
26 <Project> post configuration procedures
27 -----------------------------------------
28 Describe any deploy tool or feature specific scripts, tests or procedures
29 that should be carried out on the deployment post install and configuration
30 in this section.
31
32 Platform components validation
33 ---------------------------------
34 Describe any component specific validation procedures necessary for your
35 deployment tool in this section.