From 5beb1de8dddbc338a45b1d853ef51f436c505e82 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Thu, 12 Nov 2015 11:17:11 +0900 Subject: [PATCH] Move the content of CONTRIBUTING.rst to doc/source When using cross reference across docs, it is easy to handle them if the document itself in doc/source. Otherwise, if we see CONTRIBUTING.rst in the top directory directly, we cannot follow sphinx references. Change-Id: I96b6cd24dcbf16e3923e4bc6fe4069d692e75993 --- CONTRIBUTING.rst | 53 ++----------------------------------- doc/source/CONTRIBUTING.rst | 1 - doc/source/contributing.rst | 51 +++++++++++++++++++++++++++++++++++ doc/source/index.rst | 2 +- 4 files changed, 54 insertions(+), 53 deletions(-) delete mode 120000 doc/source/CONTRIBUTING.rst create mode 100644 doc/source/contributing.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 0f727e6..d5f638c 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,51 +1,2 @@ -Contributing -============ - -The I18n team welcomes any kinds of contribution. - -Contribute to translations --------------------------- - -To help with translation, `become an official translator`_ -and join your language team. -Then go to `translation website`_ to start translation. -You can find prioritized translation jobs at the top of the page. -If you have questions, you can contact your coordinators. - -If you cannot find your local team, -you can request to `create a local translation team`_. - -To report translation errors, -go to `openstack-i18n in Launchpad`_ and report bugs. -Mark bugs with a tag "translation". - -There are three different roles in a translation team: - -Member (translator) - A person who can submit translations. - -Reviewer - A person who can proofread translations and - mark them as reviewed (approved) or rejected. - -Coordinator - A privileged member in a translation team who can help - in team management tasks, such as approving new members - and reviewing contributions to that language. - We also have task coordinators for specific tasks. - -Contribute to translation tools -------------------------------- - -Go to the `translation tools`_ page to understand the tools -and scripts which support our translation platform. -If you want to help to report bugs, add more wishlists, and improve them, -you can report and fix bugs at `openstack-i18n in Launchpad`_. -Mark bugs with a tag "tools". - - -.. _`become an official translator`: https://wiki.openstack.org/wiki/I18nTeam/become-a-official-translator -.. _`translation website`: https://translate.openstack.org/ -.. _`create a local translation team`: https://wiki.openstack.org/wiki/I18nTeam/CreateLocalTeam -.. _`openstack-i18n in Launchpad`: https://bugs.launchpad.net/openstack-i18n -.. _`translation tools`: https://wiki.openstack.org/wiki/I18n/Tools +See doc/source/contributing.rst or +http://docs.openstack.org/developer/i18n/. diff --git a/doc/source/CONTRIBUTING.rst b/doc/source/CONTRIBUTING.rst deleted file mode 120000 index e9a8ba6..0000000 --- a/doc/source/CONTRIBUTING.rst +++ /dev/null @@ -1 +0,0 @@ -../../CONTRIBUTING.rst \ No newline at end of file diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst new file mode 100644 index 0000000..0f727e6 --- /dev/null +++ b/doc/source/contributing.rst @@ -0,0 +1,51 @@ +Contributing +============ + +The I18n team welcomes any kinds of contribution. + +Contribute to translations +-------------------------- + +To help with translation, `become an official translator`_ +and join your language team. +Then go to `translation website`_ to start translation. +You can find prioritized translation jobs at the top of the page. +If you have questions, you can contact your coordinators. + +If you cannot find your local team, +you can request to `create a local translation team`_. + +To report translation errors, +go to `openstack-i18n in Launchpad`_ and report bugs. +Mark bugs with a tag "translation". + +There are three different roles in a translation team: + +Member (translator) + A person who can submit translations. + +Reviewer + A person who can proofread translations and + mark them as reviewed (approved) or rejected. + +Coordinator + A privileged member in a translation team who can help + in team management tasks, such as approving new members + and reviewing contributions to that language. + We also have task coordinators for specific tasks. + +Contribute to translation tools +------------------------------- + +Go to the `translation tools`_ page to understand the tools +and scripts which support our translation platform. +If you want to help to report bugs, add more wishlists, and improve them, +you can report and fix bugs at `openstack-i18n in Launchpad`_. +Mark bugs with a tag "tools". + + +.. _`become an official translator`: https://wiki.openstack.org/wiki/I18nTeam/become-a-official-translator +.. _`translation website`: https://translate.openstack.org/ +.. _`create a local translation team`: https://wiki.openstack.org/wiki/I18nTeam/CreateLocalTeam +.. _`openstack-i18n in Launchpad`: https://bugs.launchpad.net/openstack-i18n +.. _`translation tools`: https://wiki.openstack.org/wiki/I18n/Tools diff --git a/doc/source/index.rst b/doc/source/index.rst index 1a535a0..6a82f31 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -14,7 +14,7 @@ Contents .. toctree:: :maxdepth: 2 - CONTRIBUTING + contributing Getting in touch ~~~~~~~~~~~~~~~~