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.
   5 To do so, you will however need to first get an enviroment set up.
   6
   7 Development Environment
   8 #######################
   9
  10 All project data such as formatting guidelines, and upstream mapping is documented via sphinx
  11 which uses reStructuredText
  12
  13 It is recommended that you use a python virtualenv to keep things clean and contained.
  14
  15 VirtualEnv
  16 **********
  17
  18 Use of a virtual environment is recommended, as not only is it a quick easy form of
  19 getting the needed modules in place, it isolates the module versions to a project.
  20
  21 From within your inspector directory, set up a new virtualenv::
  22
  23     virtualenv venv
  24
  25 Activate the new virtual environment::
  26
  27     source venv/bin/activate
  28
  29 Install requirements::
  30
  31     pip install -r requirements.txt
  32
  33 Sphinx Basics
  34 *************
  35
  36 To get started with sphinx, visit the main tutorial which will provide a primer `http://sphinx-doc.org/tutorial.html`
  37
  38 Hack your changes into opnfv-security-guide/source
  39
  40 To compile changes:
  41
  42     make html
  43
  44 From here you can run a basic python web server or just navigate to the
  45 file:///<repo>/opnfv-security-guide/build/html/index.html in your browser