requirements_projects:security:opnfvsg
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
requirements_projects:security:opnfvsg [2015/10/30 11:17] Luke Hinds created |
requirements_projects:security:opnfvsg [2015/10/30 11:22] (current) Luke Hinds [Git Repo] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | The OPNFV Security Guide | + | ====== 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 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 platfornm. | + | 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. | It is a living document that is updated as new changes are merged into it's repository. | ||
| - | How to Contribute | + | ====== 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. | 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 | + | ===== Development Environment ===== |
| - | ####################### | + | |
| All project data such as formatting guidelines, and upstream mapping is documented via sphinx which uses reStructuredText | All project data such as formatting guidelines, and upstream mapping is documented via sphinx which uses reStructuredText | ||
| Line 19: | Line 19: | ||
| It is recommended that you use a python virtualenv to keep things clean and contained. | It is recommended that you use a python virtualenv to keep things clean and contained. | ||
| - | VirtualEnv | + | ==== 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. | 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:: | + | From within your opnfv-security-guide directory, set up a new virtualenv:: |
| virtualenv venv | virtualenv venv | ||
| Line 36: | Line 40: | ||
| pip install -r requirements.txt | pip install -r requirements.txt | ||
| - | Sphinx Basics | + | |
| - | ************* | + | ==== Sphinx Basics ==== |
| To get started with sphinx, visit the main tutorial which will provide a primer `http://sphinx-doc.org/tutorial.html` | To get started with sphinx, visit the main tutorial which will provide a primer `http://sphinx-doc.org/tutorial.html` | ||
requirements_projects/security/opnfvsg.1446203862.txt.gz · Last modified: 2015/10/30 11:17 by Luke Hinds
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: Creative Commons Attribution 4.0 International License
