summaryrefslogtreecommitdiffstats
path: root/docs/opnfvsecguide/contribution.rst
diff options
context:
space:
mode:
authorSofia Wallin <sofia.wallin@ericsson.com>2016-11-23 14:49:15 +0100
committerSofia Wallin <sofia.wallin@ericsson.com>2016-11-24 16:21:30 +0100
commitd438301ca7244e66d5082312e3e84fcfb219f11b (patch)
tree858fc757706d451ac52e17ba75e4c0d7b4a2ef6d /docs/opnfvsecguide/contribution.rst
parent978b48ae0117c80d3dc7cced5e09e08e9efe929b (diff)
Adjusted the docs repo structure for D release work
Change-Id: I9befe06c424c726e17d754bc480413b2430549ba Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
Diffstat (limited to 'docs/opnfvsecguide/contribution.rst')
-rw-r--r--docs/opnfvsecguide/contribution.rst45
1 files changed, 0 insertions, 45 deletions
diff --git a/docs/opnfvsecguide/contribution.rst b/docs/opnfvsecguide/contribution.rst
deleted file mode 100644
index 683aa2d14..000000000
--- a/docs/opnfvsecguide/contribution.rst
+++ /dev/null
@@ -1,45 +0,0 @@
-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