From 1e1760476ea5acc2f501f3244ceab1c4b018f1f9 Mon Sep 17 00:00:00 2001 From: Ildiko Vancsa Date: Thu, 17 May 2018 07:29:03 -0700 Subject: [PATCH] Add information on the Sandbox projects This change adds information about the Git sandbox repository and the Sandbox projects in Launchpad and StoryBoard. Story: 2001360 Task: 5924 Change-Id: I063ddc9d677ce68c847081e1c6490db751257f4f --- doc/source/code-and-documentation/index.rst | 1 + .../sandbox-house-rules.rst | 69 +++++++++++++++++++ .../code-and-documentation/using-gerrit.rst | 2 + doc/source/common/git.rst | 2 + doc/source/common/task-tracking.rst | 4 ++ 5 files changed, 78 insertions(+) create mode 100644 doc/source/code-and-documentation/sandbox-house-rules.rst diff --git a/doc/source/code-and-documentation/index.rst b/doc/source/code-and-documentation/index.rst index 29344de..2c2cbad 100644 --- a/doc/source/code-and-documentation/index.rst +++ b/doc/source/code-and-documentation/index.rst @@ -21,3 +21,4 @@ Code & Documentation Contributor Guide /common/zuul-status /code-and-documentation/elastic-recheck /common/i18n + /code-and-documentation/sandbox-house-rules diff --git a/doc/source/code-and-documentation/sandbox-house-rules.rst b/doc/source/code-and-documentation/sandbox-house-rules.rst new file mode 100644 index 0000000..269bebc --- /dev/null +++ b/doc/source/code-and-documentation/sandbox-house-rules.rst @@ -0,0 +1,69 @@ +############################### +How to Use the Sandbox Projects +############################### + +The tools that we are using in the community can look complicated if you are +not familiar with them. To help you practice before you use them in action we +are providing sandbox environments for you where you can practice all the steps +we describe in this guide. + +This section allows you to: + +* Get an overview of the available projects for practice +* Get guidelines on how to use them + +General Information +=================== + +All the Sandbox repository and projects are identical to any other active +project's resources. You can find the same information and same functionality +as well to ensure you can practice everything you need to know about the tool. + +You get permissions to perform all the operations in the Sandbox project for +the sake of practice. When you join a project as a contributor you will have +limited access to the functionalities as there are actions only core reviewers +can perform. You can find information about these in the respective sections of +the Contributor Guide. + +The Sandbox repository and projects are maintained by community members with +occasional cleanup. Please help us with the housekeeping and clean up your +work, when you are finished with your practice and feel comfortable using the +tool. + +SandBox Git Repository +====================== + +Git is a version control system that we use to track changes to our source code +and documentation. + +You can find a `sandbox Git repository +`_ where you can practice +the Git commands before you put together a patch to resolve a bug or implement +a new functionality. + +You can find instructions on how to use Git in the :ref:`git` section. + +You can upload your changes to the sandbox repository and review it on Gerrit +as it is described in the :ref:`gerrit` section. + +Sandbox Project on StoryBoard +============================= + +:ref:`storyboard` is a community-developed task tracking tool. The +community-wide adoption of the tool is in progress, you will find more and more +projects who migrated over to using StoryBoard already. + +You can find a `Sandbox `_ +project in the tool that provides all the functionalities to you as any of the +other active projects. + +SandBox Project on Launchpad +============================ + +:ref:`launchpad` is one of the task tracking tools that the community is using. + +.. note:: Launchpad is deprecated and will be superseeded by StoryBoard. + +There is a `Sandbox project `_ +available there which is created to track bugs and issues related to the +openstack-dev/sandbox repository. diff --git a/doc/source/code-and-documentation/using-gerrit.rst b/doc/source/code-and-documentation/using-gerrit.rst index d213a28..9f7a02a 100644 --- a/doc/source/code-and-documentation/using-gerrit.rst +++ b/doc/source/code-and-documentation/using-gerrit.rst @@ -1,3 +1,5 @@ +.. _gerrit: + ############ Using Gerrit ############ diff --git a/doc/source/common/git.rst b/doc/source/common/git.rst index 806121b..2e2e042 100644 --- a/doc/source/common/git.rst +++ b/doc/source/common/git.rst @@ -1,3 +1,5 @@ +.. _git: + ################### Setup and Learn GIT ################### diff --git a/doc/source/common/task-tracking.rst b/doc/source/common/task-tracking.rst index 26a7d87..5aa1205 100644 --- a/doc/source/common/task-tracking.rst +++ b/doc/source/common/task-tracking.rst @@ -27,6 +27,8 @@ Storyboard. .. _project list: https://governance.openstack.org/tc/reference/projects/index.html +.. _storyboard: + Storyboard ========== @@ -62,6 +64,8 @@ milestone. A lane could have all the bugs or all the new features. It depends on the teams way of organizing and coordinating work. Order of stories in a worklist could convey priority as well. +.. _launchpad: + Launchpad =========