security:opnfv-security-guide
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
security:opnfv-security-guide [2015/10/30 12:14] Luke Hinds created |
security:opnfv-security-guide [2016/03/09 11:31] (current) Luke Hinds |
||
|---|---|---|---|
| Line 9: | Line 9: | ||
| 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. | ||
| - | Initial structure is being collated on etherpad: | + | Sections are tracked within JIRA, using the label 'SECGUIDE': |
| + | |||
| + | https://jira.opnfv.org/browse/SECURITY-12?jql=labels%20%3D%20SECGUIDE | ||
| + | |||
| + | Initial layout pad: | ||
| https://etherpad.opnfv.org/p/security-guide | https://etherpad.opnfv.org/p/security-guide | ||
| Line 15: | Line 19: | ||
| ====== 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 environment set up. |
| ===== Development Environment ===== | ===== Development Environment ===== | ||
| Line 21: | Line 25: | ||
| 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 | ||
| - | It is recommended that you use a python virtualenv to keep things clean and contained. | + | ==== Git / Gerrit Setup ==== |
| - | + | ||
| - | ==== 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. | + | For the below to work, you will need to have a linux foundation account setup, and have added your public SSH key to gerrit. |
| - | From within your opnfv-security-guide directory, set up a new virtualenv:: | + | git clone ssh://<your-username>@gerrit.opnfv.org:29418/opnfvdocs |
| - | virtualenv venv | + | cd opnfvdocs/docs/opnfvsecguide |
| - | Activate the new virtual environment:: | + | git review -s |
| - | source venv/bin/activate | + | * Git review sets up your env to work with the remote gerrit server, you may get some errors here if your SSH key is not found, or it picks up the wrong one. |
| - | Install requirements:: | + | Now make your changes to the documentation, and then perform a git add to 'stage' the changes. |
| - | pip install -r requirements.txt | + | git add . |
| - | ==== Sphinx Basics ==== | + | * If you prefer, you can cherry pick a change i.e. git add myfile.txt (git add . # Add all changes) |
| - | To get started with sphinx, visit the main tutorial which will provide a primer `http://sphinx-doc.org/tutorial.html` | + | git commit -a --signoff |
| - | Hack your changes into opnfv-security-guide/source | + | Add a descriptive change of what you did, and save out of the commit window (so if your in vi then :wq) and make a push for review. |
| - | To compile changes: | + | git review |
| - | make html | + | Now await for core reviewers to +1 and it will get built to artefacts , you will see the url on the gerrit page returned by git review. Here is an example: |
| - | 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 | + | [hinds@casper opnfvsecguide] $ git review |
| + | remote: Resolving deltas: 100% (6/6) | ||
| + | remote: New file detected, please ensure that it has the correct license header | ||
| + | remote: Processing changes: new: 1, refs: 1, done | ||
| + | remote: | ||
| + | remote: New Changes: | ||
| + | remote: https://gerrit.opnfv.org/gerrit/7825 | ||
| + | remote: | ||
| + | To ssh://lukehinds@gerrit.opnfv.org:29418/opnfvdocs.git | ||
| + | * [new branch] HEAD -> refs/publish/master | ||
security/opnfv-security-guide.1446207250.txt.gz · Last modified: 2015/10/30 12:14 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
