From 1dfe31d1bf6a0fd48aa6ee16a95a7e61d7af9b93 Mon Sep 17 00:00:00 2001 From: Dmitry Tantsur Date: Thu, 4 Jun 2020 10:40:21 +0200 Subject: [PATCH] Documentation: reorder the contributors guide * Move code contribution one level down * Move Vagrant and libvirt information from the user guide * Place the libvirt information under testenv Change-Id: I1c97d632e986e4562ec1e93bc835a23b0045a56f --- doc/source/contributor/contributing.rst | 5 +++++ doc/source/contributor/index.rst | 14 +++++--------- doc/source/contributor/testenv.rst | 7 +++++++ doc/source/{user => contributor}/vagrant.rst | 0 doc/source/{user => contributor}/virsh.rst | 0 doc/source/user/index.rst | 2 -- 6 files changed, 17 insertions(+), 11 deletions(-) create mode 100644 doc/source/contributor/contributing.rst rename doc/source/{user => contributor}/vagrant.rst (100%) rename doc/source/{user => contributor}/virsh.rst (100%) diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 000000000..3d4ceb40a --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,5 @@ +============ +Contributing +============ + +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 16262cd96..1b7674044 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -1,14 +1,10 @@ -============ -Contributing -============ - -.. include:: ../../../CONTRIBUTING.rst - ------------- -Other Topics ------------- +================= +Contributor Guide +================= .. toctree:: :maxdepth: 1 + contributing + vagrant testenv diff --git a/doc/source/contributor/testenv.rst b/doc/source/contributor/testenv.rst index 804edbe90..d7afabc2c 100644 --- a/doc/source/contributor/testenv.rst +++ b/doc/source/contributor/testenv.rst @@ -57,5 +57,12 @@ hardware type can be used as for real hardware. in the previous step. #. Run the deployment step, as documented in :ref:`deploy`. +Configuring libvirt +------------------- + +.. toctree:: + + virsh + .. _VirtualBMC: https://docs.openstack.org/virtualbmc/ diff --git a/doc/source/user/vagrant.rst b/doc/source/contributor/vagrant.rst similarity index 100% rename from doc/source/user/vagrant.rst rename to doc/source/contributor/vagrant.rst diff --git a/doc/source/user/virsh.rst b/doc/source/contributor/virsh.rst similarity index 100% rename from doc/source/user/virsh.rst rename to doc/source/contributor/virsh.rst diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst index 69e969d20..0fed296ab 100644 --- a/doc/source/user/index.rst +++ b/doc/source/user/index.rst @@ -8,8 +8,6 @@ this documentation serves as a blend of both Admin and User documentation. .. toctree:: :maxdepth: 1 - vagrant - virsh howto troubleshooting