====== The OPNFV Security Guide ======

The OPNFV Security Guide is the collaborative work of many individuals, involved in both the OPNFV Security Group and the wider OPNFV community.

The purpose of the guide is to provide the best practice security guidelines for deploying the OPNFV platform. 

Developers of all OPNFV projects are encouraged to contribute with security specifics to their projects.

It is a living document that is updated as new changes are merged into it's repository.

====== 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. 

==== Git Repo ====

    git clone https://github.com/lukehinds/opnfv-security-guide.git
    
* Note, the above is a temporary staging repo. 
==== 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 opnfv-security-guide 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