]> review.fuel-infra Code Review - openstack-build/neutron-build.git/commitdiff
Updated the README.rst
authorJJ Asghar <jj@getchef.com>
Sat, 29 Nov 2014 20:14:54 +0000 (14:14 -0600)
committerJJ Asghar <jj@getchef.com>
Tue, 2 Dec 2014 20:33:30 +0000 (14:33 -0600)
Updated the Readme.rst with some formatting issues. Also
stole the ending line from the Nova to point in the direction
of the CONTRIBUTING.rst.

Change-Id: I595b7feb641aee91d47ba55eedab29e7511bfa35

README.rst

index 9a7bd5bc270079f773f4cfeabe4838470cda3b73..86f6ba868fd17157ca5008a6a688af8a9b60e300 100644 (file)
@@ -1,26 +1,30 @@
-# -- Welcome!
+Welcome!
+========
 
-  You have come across a cloud computing network fabric controller.  It has
-  identified itself as "Neutron."  It aims to tame your (cloud) networking!
+You have come across a cloud computing network fabric controller. It has
+identified itself as "Neutron." It aims to tame your (cloud) networking!
 
-# -- External Resources:
+External Resources:
+===================
 
- The homepage for Neutron is: http://launchpad.net/neutron.  Use this
- site for asking for help, and filing bugs. Code is available on
- git.openstack.org at
- <http://git.openstack.org/cgit/openstack/neutron>.
+The homepage for Neutron is: http://launchpad.net/neutron.  Use this
+site for asking for help, and filing bugs. Code is available on
+git.openstack.org at <http://git.openstack.org/cgit/openstack/neutron>.
 
- The latest and most in-depth documentation on how to use Neutron is
- available at: <http://docs.openstack.org>.  This includes:
+The latest and most in-depth documentation on how to use Neutron is
+available at: <http://docs.openstack.org>. This includes:
 
- Neutron Administrator Guide
- http://docs.openstack.org/trunk/openstack-network/admin/content/
+Neutron Administrator Guide
+   http://docs.openstack.org/admin-guide-cloud/content/ch_networking.html
 
- Neutron API Reference:
- http://docs.openstack.org/api/openstack-network/2.0/content/
+Neutron API Reference:
  http://docs.openstack.org/api/openstack-network/2.0/content/
 
- The start of some developer documentation is available at:
- http://wiki.openstack.org/NeutronDevelopment
+Current Neutron developer documentation is available at:
  http://wiki.openstack.org/NeutronDevelopment
 
- For help using or hacking on Neutron, you can send mail to
- <mailto:openstack-dev@lists.openstack.org>.
+For help on usage and hacking of Neutron, please send mail to
+<mailto:openstack-dev@lists.openstack.org>.
+
+For information on how to contribute to Neutron, please see the
+contents of the CONTRIBUTING.rst file.