docs/opnfvsecguide/contribution.rst

   1 How to Contribute
   2 -----------------
   3
   4 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.
   5
   6 Development Environment
   7 #######################
   8
   9 All project data such as formatting guidelines, and upstream mapping is documented via sphinx which uses reStructuredText
  10
  11 It is recommended that you use a python virtualenv to keep things clean and contained.
  12
  13 VirtualEnv
  14 **********
  15
  16 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.
  17
  18 From within your inspector directory, set up a new virtualenv::
  19
  20     virtualenv venv
  21
  22 Activate the new virtual environment::
  23
  24     source venv/bin/activate
  25
  26 Install requirements::
  27
  28     pip install -r requirements.txt
  29
  30 Sphinx Basics
  31 *************
  32
  33 To get started with sphinx, visit the main tutorial which will provide a primer `http://sphinx-doc.org/tutorial.html`
  34
  35 Hack your changes into opnfv-security-guide/source
  36
  37 To compile changes:
  38
  39     make html
  40
  41 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