diff options
| author |   ShubhamRathi <shubhamiiitbackup@gmail.com> | 2017-01-10 18:20:30 +0530 |
|---|---|---|
| committer |   Christopher Price <christopher.price@ericsson.com> | 2017-01-15 16:26:41 +0000 |
| commit | 326c546133c46a8fa51aee3631cc23d71cacaca4 (patch) | |
| tree | 6c62e8e41239e8922b7891d2b3ea879e118050a3 /docs/release/Templates/Installation/<scenario> | |
| parent | 26e52332eb28812b3415aaefc6f53a7637a222fe (diff) | |
Add new templates for docs contribution
Adding new templates for docs contribution to be used by the project
teams. Templates for 'Testing/' havent been added yet since its not
perfectly clear what all cases need to be documented.
Change-Id: Id9c1d0d87d99bb071cbcd493817500666cd59b79
Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
Diffstat (limited to 'docs/release/Templates/Installation/<scenario>')
3 files changed, 49 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 |