|
|
|
@ -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
|
|
|
|
|
<https://git.openstack.org/cgit/openstack-dev/sandbox>`_ 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 <https://storyboard-dev.openstack.org/#!/project/2>`_
|
|
|
|
|
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 <https://launchpad.net/openstack-dev-sandbox>`_
|
|
|
|
|
available there which is created to track bugs and issues related to the
|
|
|
|
|
openstack-dev/sandbox repository.
|