diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..c5bcf8a --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,76 @@ +.. + Except where otherwise noted, this document is licensed under Creative + Commons Attribution 3.0 License. You can view the license at: + + https://creativecommons.org/licenses/by/3.0/ + +.. _contributing: + +======================= +Contributing to Watcher +======================= + +If you're interested in contributing to the Watcher project, +the following will help get you started. + +Contributor License Agreement +----------------------------- + +.. index:: + single: license; agreement + +In order to contribute to the Watcher project, you need to have +signed OpenStack's contributor's agreement. + +.. seealso:: + + * http://docs.openstack.org/infra/manual/developers.html + * http://wiki.openstack.org/CLA + +LaunchPad Project +----------------- + +Most of the tools used for OpenStack depend on a launchpad.net ID for +authentication. After signing up for a launchpad account, join the +"openstack" team to have access to the mailing list and receive +notifications of important events. + +.. seealso:: + + * http://launchpad.net + * http://launchpad.net/watcher + * http://launchpad.net/watcher-dashboard + * http://launchpad.net/~openstack + + +Project Hosting Details +----------------------- + +Bug tracker + http://launchpad.net/watcher-dashboard + +Blueprints + https://blueprints.launchpad.net/watcher-dashboard + +Mailing list (prefix subjects with ``[watcher]`` for faster responses) + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev + +Wiki + http://wiki.openstack.org/Watcher + +Code Hosting + https://git.openstack.org/cgit/openstack/watcher-dashboard + +Code Review + https://review.openstack.org/#/q/status:open+project:openstack/watcher-dashboard,n,z + +IRC Channel + ``#openstack-watcher`` (changelog_) + +Weekly Meetings + On Wednesdays at 14:00 UTC on even weeks in the ``#openstack-meeting-4`` + IRC channel, 13:00 UTC on odd weeks in the ``#openstack-meeting-alt`` + IRC channel (`meetings logs`_) + +.. _changelog: http://eavesdrop.openstack.org/irclogs/%23openstack-watcher/ +.. _meetings logs: http://eavesdrop.openstack.org/meetings/watcher/ \ No newline at end of file diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000..e4506d5 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,4 @@ +.. toctree:: + :maxdepth: 1 + + contributing \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst index e36adb6..c7546a0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -33,16 +33,21 @@ specific prior release. .. _watcher-dashboard: https://git.openstack.org/cgit/openstack/watcher-dashboard/ -Developer Guide -=============== - -Introduction ------------- +Install Guide +============= .. toctree:: :maxdepth: 1 - deploy/installation + install/index + +Developer Guide +=============== + +.. toctree:: + :maxdepth: 1 + + contributor/index Indices and tables diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst new file mode 100644 index 0000000..ac607b3 --- /dev/null +++ b/doc/source/install/index.rst @@ -0,0 +1,4 @@ +.. toctree:: + :maxdepth: 1 + + installation \ No newline at end of file diff --git a/doc/source/deploy/installation.rst b/doc/source/install/installation.rst similarity index 100% rename from doc/source/deploy/installation.rst rename to doc/source/install/installation.rst