Skip to content

Commit

Permalink
WIP.
Browse files Browse the repository at this point in the history
  • Loading branch information
gizmoguy committed Oct 27, 2017
1 parent f797731 commit 7508dc5
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 7 deletions.
13 changes: 13 additions & 0 deletions docs2/external_resources.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
External Resources on Faucet
----------------------------


Online Tutorials
================

* http://docs.openvswitch.org/en/latest/tutorials/faucet/

Tutorial Videos
===============

* https://www.youtube.com/watch?v=fuqzzjmcwlI
25 changes: 18 additions & 7 deletions docs2/index.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,28 @@
.. faucet documentation master file, created by
sphinx-quickstart on Thu Oct 26 13:48:25 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
User Documentation
==================

.. toctree::
:maxdepth: 2

intro
external_resources

Welcome to faucet's documentation!
==================================
Developer Documentation
=======================

.. toctree::
:maxdepth: 2
:caption: Contents:

source/index

Quick References
================

.. toctree::
:maxdepth: 1

faq


Indices and tables
==================
Expand Down
40 changes: 40 additions & 0 deletions docs2/intro.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
Introduction to Faucet
######################

What is Faucet?
===============


What is Gauge?
===============


Why Faucet?
===========

https://queue.acm.org/detail.cfm?id=3015763

Getting Help
============

We use maintain a number of mailing lists for communicating with users and
developers:

* `faucet-announce <https://list.waikato.ac.nz/mailman/listinfo/faucet-announce>`_
* `faucet-dev <https://list.waikato.ac.nz/mailman/listinfo/faucet-dev>`_
* `faucet-users <https://lists.geant.org/sympa/info/faucet-users>`_

We also have the #faucetsdn IRC channel on
`freenode <https://webchat.freenode.net/?channels=#faucetsdn>`_.

A few tutorial videos are available on our
`YouTube channel <https://www.youtube.com/channel/UChRZ5O2diT7QREazfQX0stQ>`_.

The
`faucetsdn blog <https://faucet-sdn.blogspot.co.nz>`_
and
`faucetsdn twitter <https://twitter.com/faucetsdn>`_
are good places to keep up with the latest news about faucet.

If you find bugs, or if have feature requests, please create an issue on our
`bug tracker <https://github.com/faucetsdn/faucet/issues>`_.

0 comments on commit 7508dc5

Please sign in to comment.