diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index c2932e6fe..5f88466c3 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -1,6 +1,25 @@ 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: - Join the #openstack-fwaas IRC channel on Freenode. This is where the diff --git a/doc/source/index.rst b/doc/source/index.rst index 3085f73c6..8bdb9be17 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -10,6 +10,7 @@ General Information and Other Project References: :glob: :maxdepth: 1 + installation fwaas_v2 contributing diff --git a/doc/source/installation.rst b/doc/source/installation.rst new file mode 100644 index 000000000..b104aa7d2 --- /dev/null +++ b/doc/source/installation.rst @@ -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 `_ or +the `Firewall-as-a-Service (FWaaS) v1 scenario `_.