[ovs-dev] [PATCH] Documentation: Add Faucet tutorial.

Ben Pfaff blp at ovn.org
Tue Oct 24 21:04:51 UTC 2017


On Wed, Oct 18, 2017 at 11:00:18PM -0700, Han Zhou wrote:
> On Wed, Oct 18, 2017 at 2:05 PM, Ben Pfaff <blp at ovn.org> wrote:
> 
> > This is for a talk at the Faucet conference on Oct. 19:
> > http://conference.faucet.nz/schedule/
> >
> > Signed-off-by: Ben Pfaff <blp at ovn.org>
> > ---
> >  Documentation/automake.mk          |    1 +
> >  Documentation/tutorials/faucet.rst | 1462 ++++++++++++++++++++++++++++++
> > ++++++
> >  Documentation/tutorials/index.rst  |    1 +
> >  3 files changed, 1464 insertions(+)
> >  create mode 100644 Documentation/tutorials/faucet.rst
> >
> > diff --git a/Documentation/automake.mk b/Documentation/automake.mk
> > index 6f38912f264b..da482b419887 100644
> > --- a/Documentation/automake.mk
> > +++ b/Documentation/automake.mk
> > @@ -23,6 +23,7 @@ DOC_SOURCE = \
> >         Documentation/intro/install/windows.rst \
> >         Documentation/intro/install/xenserver.rst \
> >         Documentation/tutorials/index.rst \
> > +       Documentation/tutorials/faucet.rst \
> >         Documentation/tutorials/ovs-advanced.rst \
> >         Documentation/tutorials/ovn-openstack.rst \
> >         Documentation/tutorials/ovn-sandbox.rst \
> > diff --git a/Documentation/tutorials/faucet.rst b/Documentation/tutorials/
> > faucet.rst
> > new file mode 100644
> > index 000000000000..67c663649f72
> > --- /dev/null
> > +++ b/Documentation/tutorials/faucet.rst
> > @@ -0,0 +1,1462 @@
> > +..
> > +      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 Open vSwitch documentation:
> > +
> > +      =======  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.
> > +
> > +===================
> > +OVS Faucet Tutorial
> > +===================
> > +
> > +This tutorial demonstrates how Open vSwitch works with a controller,
> > using the
> >
> 
> s/controller/general purpose OpenFlow controller
> 
> Otherwise, people may get confused why wouldn't OVN demonstrate the same.

Thanks, I made that change.


More information about the dev mailing list