diff --git a/doc/source/contributing.rst b/doc/source/contributor/contributing.rst similarity index 100% rename from doc/source/contributing.rst rename to doc/source/contributor/contributing.rst diff --git a/doc/source/gmr.rst b/doc/source/contributor/gmr.rst similarity index 100% rename from doc/source/gmr.rst rename to doc/source/contributor/gmr.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 00000000..9d9684a0 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,15 @@ +================== +Contribution Guide +================== + +In the Contribution Guide, you will find documented policies for +developing with Panko. This includes the processes we use for +bugs, contributor onboarding, core reviewer memberships, and other +procedural items. + +.. toctree:: + :maxdepth: 2 + + contributing + testing + gmr diff --git a/doc/source/testing.rst b/doc/source/contributor/testing.rst similarity index 100% rename from doc/source/testing.rst rename to doc/source/contributor/testing.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index b7b289bb..c0526185 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -13,9 +13,13 @@ License for the specific language governing permissions and limitations under the License. -============================================= -Welcome to the Panko developer documentation! -============================================= +===================================== +Welcome to the Panko's documentation! +===================================== + +The Panko project is an event storage service that provides the ability to +store and querying event data generated by Ceilometer with potentially other +sources. Panko is a component of the Telemetry project. @@ -25,30 +29,12 @@ contribute to the project. Overview ======== -.. toctree:: - :maxdepth: 2 - - webapi/index - -Developer Documentation -======================= - .. toctree:: :maxdepth: 2 install/index - testing - contributing - gmr - -Appendix -======== - -.. toctree:: - :maxdepth: 1 - - api/index - + contributor/index + webapi/index .. update index