documentation:configguide
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
documentation:configguide [2016/02/04 12:13] Christopher Price |
documentation:configguide [2016/02/08 14:58] (current) Ryota Mibu [Document structure] |
||
|---|---|---|---|
| Line 25: | Line 25: | ||
| All project specific files to be compiled into the Installation and Configuration guide must be stored in your projects configguide folder, templates for these files can be found in the opnfvdocs repo. | All project specific files to be compiled into the Installation and Configuration guide must be stored in your projects configguide folder, templates for these files can be found in the opnfvdocs repo. | ||
| - | | Installation and Configuration guide directory: |''<repo>/docs/configguide/''| | + | | Installation and Configuration guide directory: |''<repo>/docs/configguide/''| | |
| - | | Installer configuration guide: |''<repo>/docs/configguide/installerconfig.rst''| | + | | Installer configuration guide: |''<repo>/docs/configguide/installerconfig.rst''|[[https://gerrit.opnfv.org/gerrit/gitweb?p=opnfvdocs.git;a=blob;f=docs/configguide/installerconfig.rst;hb=HEAD|template]]| |
| - | | Feature configuration guide: |''<repo>/docs/configguide/featureconfig.rst''| | + | | Feature configuration guide: |''<repo>/docs/configguide/featureconfig.rst''|[[https://gerrit.opnfv.org/gerrit/gitweb?p=opnfvdocs.git;a=blob;f=docs/configguide/featureconfig.rst;hb=HEAD|template]]| |
| - | | Post installation procedures: |''<repo>/docs/configguide/postinstall.rst''| | + | | Post installation procedures: |''<repo>/docs/configguide/postinstall.rst''|[[https://gerrit.opnfv.org/gerrit/gitweb?p=opnfvdocs.git;a=blob;f=docs/configguide/postinstall.rst;hb=HEAD|template]]| |
| ==== Including your Documentation ==== | ==== Including your Documentation ==== | ||
| Line 41: | Line 41: | ||
| - | You should then add the relevant information to the template that will explain the configuration of your feature and instructions for validating that the feature was enabled successfully //like checking the results of specific test cases//. | + | You should then add the relevant information to the template that will explain the configuration of your feature and instructions for validating that the feature was enabled successfully //like checking the results of specific test cases//. Be sure to maintain the creative commons license from the template and ensure all your documentation files include the license information. |
| Once your installer or feature documentation is ready you should ensure they are compiled into the master file by adding them to the master files in the opnfvdocs repository. The index.rst file is structured in such a way that it will pull composite material via a staging file, staging files are identifiable by the "-" in their file names. Examples of the staging files are feature-config.rst, installer-config.rst and post-install.rst. You should add references to your input documents in the correct locations in these staging files. The relevant staging files for compiling project specific information are: | Once your installer or feature documentation is ready you should ensure they are compiled into the master file by adding them to the master files in the opnfvdocs repository. The index.rst file is structured in such a way that it will pull composite material via a staging file, staging files are identifiable by the "-" in their file names. Examples of the staging files are feature-config.rst, installer-config.rst and post-install.rst. You should add references to your input documents in the correct locations in these staging files. The relevant staging files for compiling project specific information are: | ||
| Line 56: | Line 56: | ||
| ' vim docs/configguide/post-install.rst ' | ' vim docs/configguide/post-install.rst ' | ||
| - | At this point you should add the references to your files into the post-install.rst file, these should be added in alphabetical order based on the projects repository name. For instance in the post installation procedures staging file you would add the line: | + | At this point you should add the references to your files into the post-install.rst file, these should be added in alphabetical order based on the projects repository name. For instance in the post installation procedures staging file you would add an include line for your project as shown below: |
| The following sections provide information on how to validate the features you have | The following sections provide information on how to validate the features you have | ||
| installed in your scenario: | installed in your scenario: | ||
| - | |||
| .. include:: ../projects/copper/configguide/postinstall.rst | .. include:: ../projects/copper/configguide/postinstall.rst | ||
| - | //.. include:: ../projects/<my_repo>/configguide/postinstall.rst// | + | .. include:: ../projects/<my_repo>/configguide/postinstall.rst |
| If this is the first contribution from your project to the composite document files you will need to add your project to the //build-composite.sh// file in the opnfvdocs directory. This is done my editing the jsdgf file and adding your repository name to the //get_repo_names()// function of the script. Assuming you are still in the opnfvdocs directory edit the file with the following command: | If this is the first contribution from your project to the composite document files you will need to add your project to the //build-composite.sh// file in the opnfvdocs directory. This is done my editing the jsdgf file and adding your repository name to the //get_repo_names()// function of the script. Assuming you are still in the opnfvdocs directory edit the file with the following command: | ||
documentation/configguide.1454588010.txt.gz · Last modified: 2016/02/04 12:13 by Christopher Price
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: Creative Commons Attribution 4.0 International License
