openstack
/
deb-networking-cisco
Code Issues Proposed changes

Update networking-cisco README 

The networking-cisco README is a little stale, this patch brings it up
to date to point at the current documentation location, and provide some
information regarding our releases.

Change-Id: Ic0d2509cb72ae5a474e07b9ea6ef82b41256844b
Closes-Bug: #1633147
This commit is contained in:
Sam Betts 2016-10-18 15:47:46 +01:00
parent 6e6dcb779b
commit 6a778972d9
2 changed files with 26 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.rst
View File

@ -14,3 +14,12 @@ Pull requests submitted through GitHub will be ignored.
Bugs should be filed on Launchpad, not GitHub:
https://bugs.launchpad.net/networking-cisco
Tox environments provided in networking-cisco:
* py27, py34 - Unit tests run against Mitaka neutron, on different python2.7 and python3.4
* newton - Unit tests run against Newton neutron with python2.7
* master - Unit tests run against master neutron with python2.7
* coverage - provides a report on the test coverage
* compare-coverage - compares coverage reports from before and after the current changes
* pep8 - Checks code against the pep8 and OpenStack hacking rules

24
README.rst
View File

@ -1,15 +1,25 @@
===============================
================
networking-cisco
===============================
================
Networking Cisco contains the Cisco vendor code for OpenStack Neutron
The networking-cisco project's goal is to provide support for Cisco networking
hardware and software in OpenStack deployments. This includes ML2 drivers and
agents for neutron, as well as other pieces of software which interact with
neutron to best utilise your Cisco products with OpenStack.
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/networking-cisco
* Documentation: http://docwiki.cisco.com/wiki/OpenStack
* Source: http://git.openstack.org/cgit/openstack/networking-cisco
* Bugs: http://bugs.launchpad.net/networking-cisco
Features
--------
Releases and Version Support
----------------------------
* TODO
From Mitaka forward, networking-cisco is branchless and releases will be made
from master. We have a goal to maintain compatibility with multiple versions of
OpenStack for as long as possible starting from version 4.0.0 which is
compatible with both Mitaka and Newton OpenStack releases.
* 4.X.X Mitaka and Newton onwards
* 3.X.X Mitaka
* 2.X.X Liberty