Add developer documentation to FWaaS
This change fleshes out the developer documentation for FWaaS to be more in line with a project like networking-sfc or networking-odl. Change-Id: Ic97d2b5db72b0cb5cffb2304a7ba7157ba389ec2
This commit is contained in:
parent
cadd0e399c
commit
e3a742a7b4
|
@ -1,6 +1,25 @@
|
||||||
Contributing to neutron-fwaas
|
Contributing to neutron-fwaas
|
||||||
=============================
|
=============================
|
||||||
|
|
||||||
|
If you would like to contribute to the development of OpenStack, you must
|
||||||
|
follow the steps documented at:
|
||||||
|
|
||||||
|
http://docs.openstack.org/infra/manual/developers.html
|
||||||
|
|
||||||
|
Once those steps have been completed, changes to OpenStack should be submitted
|
||||||
|
for review via the Gerrit tool, following the workflow documented at:
|
||||||
|
|
||||||
|
http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||||
|
|
||||||
|
Pull requests submitted through GitHub will be ignored.
|
||||||
|
|
||||||
|
Bugs should be filed on Launchpad in the 'neutron' project:
|
||||||
|
|
||||||
|
https://bugs.launchpad.net/neutron
|
||||||
|
|
||||||
|
Getting in touch with the neutron-fwaas community
|
||||||
|
==============================================
|
||||||
|
|
||||||
To contribute to the neutron-fwaas project, look at the following resources:
|
To contribute to the neutron-fwaas project, look at the following resources:
|
||||||
|
|
||||||
- Join the #openstack-fwaas IRC channel on Freenode. This is where the
|
- Join the #openstack-fwaas IRC channel on Freenode. This is where the
|
||||||
|
|
|
@ -10,6 +10,7 @@ General Information and Other Project References:
|
||||||
:glob:
|
:glob:
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
|
installation
|
||||||
fwaas_v2
|
fwaas_v2
|
||||||
contributing
|
contributing
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,39 @@
|
||||||
|
..
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||||
|
not use this file except in compliance with the License. You may obtain
|
||||||
|
a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||||||
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||||||
|
License for the specific language governing permissions and limitations
|
||||||
|
under the License.
|
||||||
|
|
||||||
|
|
||||||
|
Convention for heading levels in Neutron devref:
|
||||||
|
======= Heading 0 (reserved for the title in a document)
|
||||||
|
------- Heading 1
|
||||||
|
~~~~~~~ Heading 2
|
||||||
|
+++++++ Heading 3
|
||||||
|
''''''' Heading 4
|
||||||
|
(Avoid deeper levels because they do not render well.)
|
||||||
|
|
||||||
|
|
||||||
|
============
|
||||||
|
Installation
|
||||||
|
============
|
||||||
|
|
||||||
|
At the command line::
|
||||||
|
|
||||||
|
$ pip install neutron-fwaas
|
||||||
|
|
||||||
|
Or, if you have virtualenvwrapper installed::
|
||||||
|
|
||||||
|
$ mkvirtualenv neutron-fwaas
|
||||||
|
$ pip install neutron-fwaas
|
||||||
|
|
||||||
|
For information on what to do with FWaaS once it is installed, please check the
|
||||||
|
Networking Guide `Firewall-as-a-Service (FWaaS) v2 scenario <http://docs.openstack.org/newton/networking-guide/fwaas-v2-scenario.html>`_ or
|
||||||
|
the `Firewall-as-a-Service (FWaaS) v1 scenario <http://docs.openstack.org/newton/networking-guide/fwaas-v1-scenario.html>`_.
|
Loading…
Reference in New Issue