diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/admin/image-building.rst (renamed from doc/image-building.rst) | 0 | ||||
| -rw-r--r-- | doc/source/admin/index.rst | 18 | ||||
| -rw-r--r-- | doc/source/admin/template-override/opendaylight-source.rst (renamed from doc/template-override/opendaylight-source.rst) | 0 | ||||
| -rw-r--r-- | doc/source/admin/template-override/ovs-dpdk.rst (renamed from doc/template-override/ovs-dpdk.rst) | 0 | ||||
| -rw-r--r-- | doc/source/conf.py (renamed from doc/conf.py) | 0 | ||||
| -rw-r--r-- | doc/source/contributor/CONTRIBUTING.rst (renamed from doc/CONTRIBUTING.rst) | 0 | ||||
| -rw-r--r-- | doc/source/contributor/bug-triage.rst (renamed from doc/bug-triage.rst) | 0 | ||||
| -rw-r--r-- | doc/source/contributor/index.rst | 17 | ||||
| -rw-r--r-- | doc/source/contributor/running-tests.rst (renamed from doc/running-tests.rst) | 0 | ||||
| -rw-r--r-- | doc/source/index.rst (renamed from doc/index.rst) | 28 |
10 files changed, 43 insertions, 20 deletions
diff --git a/doc/image-building.rst b/doc/source/admin/image-building.rst index 4eb9d8d7e..4eb9d8d7e 100644 --- a/doc/image-building.rst +++ b/doc/source/admin/image-building.rst diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst new file mode 100644 index 000000000..4724b3bb2 --- /dev/null +++ b/doc/source/admin/index.rst @@ -0,0 +1,18 @@ +=================== +Administrator Guide +=================== + +Building Container Images +------------------------- + +If you are a system administrator running Kolla, this section contains +information that should help you understand how to build container image +or build some images using ``--template-override``. + + +.. toctree:: + :maxdepth: 2 + :glob: + + image-building + template-override/* diff --git a/doc/template-override/opendaylight-source.rst b/doc/source/admin/template-override/opendaylight-source.rst index 61a3415ba..61a3415ba 100644 --- a/doc/template-override/opendaylight-source.rst +++ b/doc/source/admin/template-override/opendaylight-source.rst diff --git a/doc/template-override/ovs-dpdk.rst b/doc/source/admin/template-override/ovs-dpdk.rst index e47cfe0ff..e47cfe0ff 100644 --- a/doc/template-override/ovs-dpdk.rst +++ b/doc/source/admin/template-override/ovs-dpdk.rst diff --git a/doc/conf.py b/doc/source/conf.py index d4a23cab2..d4a23cab2 100644 --- a/doc/conf.py +++ b/doc/source/conf.py diff --git a/doc/CONTRIBUTING.rst b/doc/source/contributor/CONTRIBUTING.rst index 7b6ce18f4..7b6ce18f4 100644 --- a/doc/CONTRIBUTING.rst +++ b/doc/source/contributor/CONTRIBUTING.rst diff --git a/doc/bug-triage.rst b/doc/source/contributor/bug-triage.rst index d5d24ca15..d5d24ca15 100644 --- a/doc/bug-triage.rst +++ b/doc/source/contributor/bug-triage.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 000000000..13430a481 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,17 @@ +============ +Development +============ + +Contributing +------------ + +This guide is to tell someone who would like to contribute to +Kolla project. Following this guide to propose your first patch for Kolla. +And we are welcome everyone to join our project! + +.. toctree:: + :maxdepth: 2 + + CONTRIBUTING.rst + running-tests + bug-triage diff --git a/doc/running-tests.rst b/doc/source/contributor/running-tests.rst index e60671c9f..e60671c9f 100644 --- a/doc/running-tests.rst +++ b/doc/source/contributor/running-tests.rst diff --git a/doc/index.rst b/doc/source/index.rst index dafbca516..b5635defd 100644 --- a/doc/index.rst +++ b/doc/source/index.rst @@ -37,30 +37,18 @@ example: https://docs.openstack.org/kolla/mitaka/ - -Kolla Overview -============== - -.. toctree:: - :maxdepth: 1 - - image-building - -Developer Docs -============== +Administrator Guide +=================== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - CONTRIBUTING - running-tests - bug-triage + admin/index -Template Override Docs -====================== +Contributor Guide +================= .. toctree:: - :maxdepth: 1 - :glob: + :maxdepth: 2 - template-override/* + contributor/index |