Add table of contents

Change-Id: I6d5ebd602380e2297735204b24f00f60c507de18
This commit is contained in:
ZhongShengping 2019-04-17 10:18:14 +08:00
parent 97eb675dcc
commit a61a0f915b

View File

@ -6,7 +6,21 @@ Team and repository tags
<!-- Change things from this point on --> <!-- Change things from this point on -->
VSwitch VSwitch
======= ====
#### Table of Contents
1. [Overview - What is the AODH module?](#overview)
2. [Development - Guide for contributing to the module](#development)
3. [Contributors - Those with commits](#contributors)
4. [Release Notes - Release notes for the project](#release-notes)
5. [Repository - The project source code repository](#repository)
6. [Usage - The usage of the module](#usage)
7. [Beaker-Rspec - Beaker-rspec tests for the project](#beaker-rpsec)
8. [Setup - The basics of getting started with AODH](#setup)
Overview
--------
4.0.0 - 2016.1 - Mitaka 4.0.0 - 2016.1 - Mitaka
@ -43,7 +57,8 @@ Repository
* https://git.openstack.org/cgit/openstack/puppet-vswitch * https://git.openstack.org/cgit/openstack/puppet-vswitch
## USAGE: Usage
-------------
To create a new bridge, use the `vs_bridge` type: To create a new bridge, use the `vs_bridge` type:
``` ```
@ -92,7 +107,8 @@ vs_config { 'array_key':
} }
``` ```
## Beaker-Rspec Beaker-Rspec
-------------
This module has beaker-rspec tests This module has beaker-rspec tests
@ -103,7 +119,8 @@ bundle install
bundle exec rspec spec/acceptance bundle exec rspec spec/acceptance
``` ```
## TODO: TODO:
-------------
* OpenFlow controller settings * OpenFlow controller settings
* OpenFlow Settings * OpenFlow Settings
* OpenFlow Tables * OpenFlow Tables