Browse Source

Merge "[doc-migration] Reorganize the Tricircle doc/source folder"

changes/73/487673/1
Jenkins 5 years ago committed by Gerrit Code Review
parent
commit
6cd177b73c
  1. 0
      doc/source/admin/api_v1.rst
  2. 3
      doc/source/admin/cli.rst
  3. 9
      doc/source/admin/index.rst
  4. 0
      doc/source/configuration/configuration.rst
  5. 8
      doc/source/configuration/index.rst
  6. 4
      doc/source/contributing.rst
  7. 4
      doc/source/contributor/contributing.rst
  8. 8
      doc/source/contributor/index.rst
  9. 48
      doc/source/index.rst
  10. 8
      doc/source/install/index.rst
  11. 0
      doc/source/install/installation-cell.rst
  12. 0
      doc/source/install/installation-guide.rst
  13. 0
      doc/source/install/installation-manual.rst
  14. 0
      doc/source/install/multi-pod-installation-devstack.rst
  15. 0
      doc/source/install/single-pod-installation-devstack.rst
  16. 8
      doc/source/networking/index.rst
  17. 0
      doc/source/networking/networking-guide-direct-provider-networks.rst
  18. 0
      doc/source/networking/networking-guide-local-networking.rst
  19. 0
      doc/source/networking/networking-guide-multiple-external-networks.rst
  20. 0
      doc/source/networking/networking-guide-multiple-ns-with-ew-enabled.rst
  21. 0
      doc/source/networking/networking-guide-single-external-network.rst
  22. 2
      doc/source/networking/networking-guide.rst
  23. 0
      doc/source/networking/networking-prerequisites.rst
  24. 2
      doc/source/networking/networking-scenarios.rst
  25. 0
      doc/source/networking/networking-terms.rst
  26. 0
      doc/source/networking/service-function-chaining-guide.rst
  27. 0
      doc/source/networking/vlan-aware-vms-guide.rst
  28. 1
      doc/source/readme.rst
  29. 9
      doc/source/user/index.rst
  30. 2
      doc/source/user/readme.rst
  31. 4
      doc/source/user/usage.rst
  32. 44
      index.rst

0
doc/source/api_v1.rst → doc/source/admin/api_v1.rst

3
doc/source/admin/cli.rst

@ -0,0 +1,3 @@
================================
Command-Line Interface Reference
================================

9
doc/source/admin/index.rst

@ -0,0 +1,9 @@
=====================
Tricircle Admin Guide
=====================
.. toctree::
:maxdepth: 3
api_v1
cli

0
doc/source/configuration.rst → doc/source/configuration/configuration.rst

8
doc/source/configuration/index.rst

@ -0,0 +1,8 @@
=============================
Tricircle Configuration Guide
=============================
.. toctree::
:maxdepth: 3
configuration

4
doc/source/contributing.rst

@ -1,4 +0,0 @@
=============
Contributing
=============
.. include:: ../../CONTRIBUTING.rst

4
doc/source/contributor/contributing.rst

@ -0,0 +1,4 @@
============
Contributing
============
.. include:: ../../../CONTRIBUTING.rst

8
doc/source/contributor/index.rst

@ -0,0 +1,8 @@
============================
Tricircle Contribution Guide
============================
.. toctree::
:maxdepth: 1
contributing

48
doc/source/index.rst

@ -7,26 +7,44 @@
Welcome to Tricircle's documentation!
=====================================
Contents
========
Tricircle User Guide
====================
.. toctree::
:maxdepth: 3
user/index
Tricircle Contribution Guide
============================
.. toctree::
:maxdepth: 2
contributor/index
Tricircle Admin Guide
=====================
.. toctree::
:maxdepth: 3
readme
usage
installation-guide
configuration
networking-guide
vlan-aware-vms-guide
service-function-chaining-guide
api_v1
contributing
admin/index
Tricircle Installation Guide
============================
.. toctree::
:maxdepth: 3
install/index
Tricircle Configuration Guide
=============================
.. toctree::
:maxdepth: 3
configuration/index
Indices and tables
==================
Tricircle Networking Guide
==========================
.. toctree::
:maxdepth: 4
* :ref:`genindex`
* :ref:`search`
networking/index

8
doc/source/install/index.rst

@ -0,0 +1,8 @@
============================
Tricircle Installation Guide
============================
.. toctree::
:maxdepth: 3
installation-guide

0
doc/source/installation-cell.rst → doc/source/install/installation-cell.rst

0
doc/source/installation-guide.rst → doc/source/install/installation-guide.rst

0
doc/source/installation-manual.rst → doc/source/install/installation-manual.rst

0
doc/source/multi-pod-installation-devstack.rst → doc/source/install/multi-pod-installation-devstack.rst

0
doc/source/single-pod-installation-devstack.rst → doc/source/install/single-pod-installation-devstack.rst

8
doc/source/networking/index.rst

@ -0,0 +1,8 @@
==========================
Tricircle Networking Guide
==========================
.. toctree::
:maxdepth: 4
networking-guide

0
doc/source/networking-guide-direct-provider-networks.rst → doc/source/networking/networking-guide-direct-provider-networks.rst

0
doc/source/networking-guide-local-networking.rst → doc/source/networking/networking-guide-local-networking.rst

0
doc/source/networking-guide-multiple-external-networks.rst → doc/source/networking/networking-guide-multiple-external-networks.rst

0
doc/source/networking-guide-multiple-ns-with-ew-enabled.rst → doc/source/networking/networking-guide-multiple-ns-with-ew-enabled.rst

0
doc/source/networking-guide-single-external-network.rst → doc/source/networking/networking-guide-single-external-network.rst

2
doc/source/networking-guide.rst → doc/source/networking/networking-guide.rst

@ -10,3 +10,5 @@ typical networking mode will be described.
.. include:: ./networking-terms.rst
.. include:: ./networking-prerequisites.rst
.. include:: ./networking-scenarios.rst
.. include:: ./service-function-chaining-guide.rst
.. include:: ./vlan-aware-vms-guide.rst

0
doc/source/networking-prerequisites.rst → doc/source/networking/networking-prerequisites.rst

2
doc/source/networking-scenarios.rst → doc/source/networking/networking-scenarios.rst

@ -3,7 +3,7 @@ Networking Scenario
===================
.. toctree::
:maxdepth: 3
:maxdepth: 4
networking-guide-direct-provider-networks.rst
networking-guide-multiple-external-networks.rst

0
doc/source/networking-terms.rst → doc/source/networking/networking-terms.rst

0
doc/source/service-function-chaining-guide.rst → doc/source/networking/service-function-chaining-guide.rst

0
doc/source/vlan-aware-vms-guide.rst → doc/source/networking/vlan-aware-vms-guide.rst

1
doc/source/readme.rst

@ -1 +0,0 @@
.. include:: ../../README.rst

9
doc/source/user/index.rst

@ -0,0 +1,9 @@
====================
Tricircle User Guide
====================
.. toctree::
:maxdepth: 3
readme
usage

2
doc/source/user/readme.rst

@ -0,0 +1,2 @@
.. include:: ../../../README.rst
:start-line: 10

4
doc/source/usage.rst → doc/source/user/usage.rst

@ -1,6 +1,6 @@
======
=====
Usage
======
=====
To use tricircle in a project::

44
index.rst

@ -0,0 +1,44 @@
.. tricircle documentation master file, created by
sphinx-quickstart on Wed Dec 2 17:00:36 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
=====================================
Welcome to Tricircle's documentation!
=====================================
User Documentation
==================
.. toctree::
:maxdepth: 3
user/index
Contributor Guide
=================
.. toctree::
:maxdepth: 1
contributor/index
Admin Guide
===========
.. toctree::
:maxdepth: 3
admin/index
Installation Guide
==================
.. toctree::
:maxdepth: 3
install/index
Configuration Guide
===================
.. toctree::
:maxdepth: 3
configuration/index
Loading…
Cancel
Save