security:opnfv-security-guide
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
security:opnfv-security-guide [2016/01/24 09:18] Luke Hinds |
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 ===== | ||
| 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 / Gerrit Setup ==== | ||
| + | |||
| + | For the below to work, you will need to have a linux foundation account setup, and have added your public SSH key to gerrit. | ||
| git clone ssh://<your-username>@gerrit.opnfv.org:29418/opnfvdocs | git clone ssh://<your-username>@gerrit.opnfv.org:29418/opnfvdocs | ||
| Line 33: | Line 37: | ||
| * 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. | * 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. | ||
| - | <make changes> | + | Now make your changes to the documentation, and then perform a git add to 'stage' the changes. |
| git add . | git add . | ||
| Line 41: | Line 45: | ||
| git commit -a --signoff | git commit -a --signoff | ||
| - | <add descriptive change> | + | 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. |
| - | + | ||
| - | Save out of the commit window (so if your in vi then :wq) | + | |
| git review | git review | ||
| - | 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: | + | 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: |
| [hinds@casper opnfvsecguide] $ git review | [hinds@casper opnfvsecguide] $ git review | ||
security/opnfv-security-guide.1453627128.txt.gz · Last modified: 2016/01/24 09:18 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
