diff options
author | Stuart Mackie <wsmackie@juniper.net> | 2017-08-29 05:21:36 -0700 |
---|---|---|
committer | Stuart Mackie <wsmackie@juniper.net> | 2017-08-29 05:21:36 -0700 |
commit | fce102283bab73ed08c292fce03e39c52f4a1fe2 (patch) | |
tree | 299e9f8e5daca49f74f207cbe6699295b9115876 /docs/development/opnfvsecguide/contribution.rst | |
parent | 711967ae9639095ce41500bb0e6f80c8b80fab95 (diff) |
Added doc directories
Change-Id: I671d7c3ad4f4e5e476c98f53780d867dc94b3089
Signed-off-by: Stuart Mackie <wsmackie@juniper.net>
Diffstat (limited to 'docs/development/opnfvsecguide/contribution.rst')
-rw-r--r-- | docs/development/opnfvsecguide/contribution.rst | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/development/opnfvsecguide/contribution.rst b/docs/development/opnfvsecguide/contribution.rst new file mode 100644 index 0000000..683aa2d --- /dev/null +++ b/docs/development/opnfvsecguide/contribution.rst @@ -0,0 +1,45 @@ +How to Contribute +----------------- + +Anyone is welcome to make additions, raise bugs, and fix issues within this Documentation. +To do so, you will however need to first get an enviroment set up. + +Development Environment +####################### + +All project data such as formatting guidelines, and upstream mapping is documented via sphinx +which uses reStructuredText + +It is recommended that you use a python virtualenv to keep things clean and contained. + +VirtualEnv +********** + +Use of a virtual environment is recommended, as not only is it a quick easy form of +getting the needed modules in place, it isolates the module versions to a project. + +From within your inspector directory, set up a new virtualenv:: + + virtualenv venv + +Activate the new virtual environment:: + + source venv/bin/activate + +Install requirements:: + + pip install -r requirements.txt + +Sphinx Basics +************* + +To get started with sphinx, visit the main tutorial which will provide a primer `http://sphinx-doc.org/tutorial.html` + +Hack your changes into opnfv-security-guide/source + +To compile changes: + + make html + +From here you can run a basic python web server or just navigate to the +file:///<repo>/opnfv-security-guide/build/html/index.html in your browser |