diff --git a/doc/source/1-agents.png b/doc/source/contributor/1-agents.png similarity index 100% rename from doc/source/1-agents.png rename to doc/source/contributor/1-agents.png diff --git a/doc/source/2-1-collection-notification.png b/doc/source/contributor/2-1-collection-notification.png similarity index 100% rename from doc/source/2-1-collection-notification.png rename to doc/source/contributor/2-1-collection-notification.png diff --git a/doc/source/2-2-collection-poll.png b/doc/source/contributor/2-2-collection-poll.png similarity index 100% rename from doc/source/2-2-collection-poll.png rename to doc/source/contributor/2-2-collection-poll.png diff --git a/doc/source/2-accessmodel.png b/doc/source/contributor/2-accessmodel.png similarity index 100% rename from doc/source/2-accessmodel.png rename to doc/source/contributor/2-accessmodel.png diff --git a/doc/source/3-Pipeline.png b/doc/source/contributor/3-Pipeline.png similarity index 100% rename from doc/source/3-Pipeline.png rename to doc/source/contributor/3-Pipeline.png diff --git a/doc/source/4-Transformer.png b/doc/source/contributor/4-Transformer.png similarity index 100% rename from doc/source/4-Transformer.png rename to doc/source/contributor/4-Transformer.png diff --git a/doc/source/5-multi-publish.png b/doc/source/contributor/5-multi-publish.png similarity index 100% rename from doc/source/5-multi-publish.png rename to doc/source/contributor/5-multi-publish.png diff --git a/doc/source/6-storagemodel.png b/doc/source/contributor/6-storagemodel.png similarity index 100% rename from doc/source/6-storagemodel.png rename to doc/source/contributor/6-storagemodel.png diff --git a/doc/source/architecture.rst b/doc/source/contributor/architecture.rst similarity index 100% rename from doc/source/architecture.rst rename to doc/source/contributor/architecture.rst diff --git a/doc/source/ceilo-arch.png b/doc/source/contributor/ceilo-arch.png similarity index 100% rename from doc/source/ceilo-arch.png rename to doc/source/contributor/ceilo-arch.png diff --git a/doc/source/ceilo-gnocchi-arch.png b/doc/source/contributor/ceilo-gnocchi-arch.png similarity index 100% rename from doc/source/ceilo-gnocchi-arch.png rename to doc/source/contributor/ceilo-gnocchi-arch.png diff --git a/doc/source/configuration.rst b/doc/source/contributor/configuration.rst similarity index 100% rename from doc/source/configuration.rst rename to doc/source/contributor/configuration.rst 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/events.rst b/doc/source/contributor/events.rst similarity index 100% rename from doc/source/events.rst rename to doc/source/contributor/events.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 0000000000..a5e28d1211 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,26 @@ +Contribution Guidelines +======================= + +In the Contributions Guide, you will find documented policies for +developing with Ceiloemter. This includes the processes we use for +bugs, contributor onboarding, core reviewer memberships, and other +procedural items. + +Developer reference +------------------- + +.. toctree:: + :maxdepth: 2 + + overview + architecture + measurements + events + contributing + install/index + configuration + plugins + new_meters + new_resource_types + testing + gmr diff --git a/doc/source/install/custom.rst b/doc/source/contributor/install/custom.rst similarity index 100% rename from doc/source/install/custom.rst rename to doc/source/contributor/install/custom.rst diff --git a/doc/source/install/dbreco.rst b/doc/source/contributor/install/dbreco.rst similarity index 100% rename from doc/source/install/dbreco.rst rename to doc/source/contributor/install/dbreco.rst diff --git a/doc/source/install/development.rst b/doc/source/contributor/install/development.rst similarity index 100% rename from doc/source/install/development.rst rename to doc/source/contributor/install/development.rst diff --git a/doc/source/install/index.rst b/doc/source/contributor/install/index.rst similarity index 100% rename from doc/source/install/index.rst rename to doc/source/contributor/install/index.rst diff --git a/doc/source/install/manual.rst b/doc/source/contributor/install/manual.rst similarity index 100% rename from doc/source/install/manual.rst rename to doc/source/contributor/install/manual.rst diff --git a/doc/source/install/upgrade.rst b/doc/source/contributor/install/upgrade.rst similarity index 100% rename from doc/source/install/upgrade.rst rename to doc/source/contributor/install/upgrade.rst diff --git a/doc/source/measurements.rst b/doc/source/contributor/measurements.rst similarity index 100% rename from doc/source/measurements.rst rename to doc/source/contributor/measurements.rst diff --git a/doc/source/new_meters.rst b/doc/source/contributor/new_meters.rst similarity index 100% rename from doc/source/new_meters.rst rename to doc/source/contributor/new_meters.rst diff --git a/doc/source/new_resource_types.rst b/doc/source/contributor/new_resource_types.rst similarity index 100% rename from doc/source/new_resource_types.rst rename to doc/source/contributor/new_resource_types.rst diff --git a/doc/source/overview.rst b/doc/source/contributor/overview.rst similarity index 100% rename from doc/source/overview.rst rename to doc/source/contributor/overview.rst diff --git a/doc/source/plugins.rst b/doc/source/contributor/plugins.rst similarity index 100% rename from doc/source/plugins.rst rename to doc/source/contributor/plugins.rst 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 2484298c88..4beca6ba12 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -34,20 +34,9 @@ Overview .. toctree:: :maxdepth: 2 - overview - architecture - measurements - events - webapi/index - install/index - configuration - plugins - new_meters - new_resource_types - testing - contributing - gmr + contributor/index admin/index + webapi/index Appendix ========