Reorganize CONTRIBUTING information
This patch moves all the contributing information from doc/source/contributing.rst to CONTRIBUTING.rst file. It also removes the installation.rst because we have the same content in the readme.rst. Change-Id: I87f992918e6db67d8182a1bcc3ba2637f922bcf5 Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
This commit is contained in:
Gael Chamoulaud (Strider)
parent
36a2a11205
commit
4a7a3c940f
@ -1,19 +1,56 @@
|
|||||||
Contributions to validations-common follow guidelines largely similar
|
For general information on contributing to OpenStack, please check out the
|
||||||
to those of other openstack projects.
|
`contributor guide <https://docs.openstack.org/contributors/>`_ to get started.
|
||||||
|
It covers all the basics that are common to all OpenStack projects: the accounts
|
||||||
|
you need, the basics of interacting with our Gerrit review system, how we
|
||||||
|
communicate as a community, etc.
|
||||||
|
|
||||||
If you're interested in contributing to the validations-libs project,
|
The information below will cover the project specific information you need to get started with TripleO.
|
||||||
the following will help get you started:
|
|
||||||
|
|
||||||
https://docs.openstack.org/infra/manual/developers.html
|
Documentation
|
||||||
|
=============
|
||||||
|
Documentation for the TripleO project can be found `here <https://docs.openstack.org/tripleo-docs/latest/index.html>`_
|
||||||
|
|
||||||
If you already have a good understanding of how the system works and your
|
Communication
|
||||||
OpenStack accounts are set up, you can skip to the development workflow
|
=============
|
||||||
section of this documentation to learn how changes to OpenStack should be
|
* IRC channel ``#validation-framework`` at `Libera`_ (For all subject-matters)
|
||||||
submitted for review via the Gerrit tool:
|
* IRC channel ``#tripleo`` at `OFTC`_ (OpenStack and TripleO discussions)
|
||||||
|
* Mailing list (prefix subjects with ``[tripleo][validations]`` for faster responses)
|
||||||
|
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
|
||||||
|
|
||||||
https://docs.openstack.org/infra/manual/developers.html#development-workflow
|
.. _Libera: https://libera.chat/
|
||||||
|
.. _OFTC: https://www.oftc.net/
|
||||||
|
|
||||||
Pull requests submitted through GitHub will be ignored.
|
Contacting the Core Team
|
||||||
|
========================
|
||||||
|
Please refer to the `TripleO Core Team
|
||||||
|
<https://review.opendev.org/#/admin/groups/190,members>`_ contacts.
|
||||||
|
|
||||||
Validations are meant to verify functionality of tripleo systems.
|
Bug Tracking
|
||||||
Therefore a special care should be given to testing your code before submitting a review.
|
=============
|
||||||
|
We track our tasks in `Launchpad <https://bugs.launchpad.net/tripleo/+bugs?field.tag=validations>`_ and in
|
||||||
|
`StoryBoard <https://storyboard.openstack.org/#!/project_group/76>`_
|
||||||
|
|
||||||
|
Reporting a Bug
|
||||||
|
===============
|
||||||
|
You found an issue and want to make sure we are aware of it? You can do so on
|
||||||
|
`Launchpad <https://bugs.launchpad.net/tripleo/+filebug>`__. Please, add the
|
||||||
|
validations tag to your bug.
|
||||||
|
|
||||||
|
More info about Launchpad usage can be found on `OpenStack docs page
|
||||||
|
<https://docs.openstack.org/contributors/common/task-tracking.html#launchpad>`_
|
||||||
|
|
||||||
|
Getting Your Patch Merged
|
||||||
|
=========================
|
||||||
|
All changes proposed to the TripleO requires two ``Code-Review +2`` votes from
|
||||||
|
TripleO core reviewers before one of the core reviewers can approve patch by
|
||||||
|
giving ``Workflow +1`` vote.
|
||||||
|
|
||||||
|
Project Team Lead Duties
|
||||||
|
========================
|
||||||
|
All common PTL duties are enumerated in the `PTL guide
|
||||||
|
<https://docs.openstack.org/project-team-guide/ptl.html>`_.
|
||||||
|
|
||||||
|
The Release Process for TripleO is documented in `Release Management
|
||||||
|
<https://docs.openstack.org/tripleo-docs/latest/developer/release.html>`_.
|
||||||
|
|
||||||
|
Documentation for the TripleO project can be found `here <https://docs.openstack.org/tripleo-docs/latest/index.html>`_
|
||||||
|
|||||||
14
README.rst
14
README.rst
@ -34,7 +34,7 @@ At the command line using `pip`.
|
|||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
$ pip install validations-common
|
$ python3 -m pip install validations-common
|
||||||
|
|
||||||
|
|
||||||
Or, if you have virtualenvwrapper_ installed.
|
Or, if you have virtualenvwrapper_ installed.
|
||||||
@ -42,17 +42,18 @@ Or, if you have virtualenvwrapper_ installed.
|
|||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
$ mkvirtualenv validations-common
|
$ mkvirtualenv validations-common
|
||||||
$ pip install validations-common
|
$ python3 -m pip install validations-common
|
||||||
|
|
||||||
Installation with package manager
|
Installation with package manager
|
||||||
---------------------------------
|
---------------------------------
|
||||||
Alternativelly it is possible to install validations-common using package manager.
|
|
||||||
|
|
||||||
Such as `yum`...
|
Alternatively it is possible to install validations-common using package manager.
|
||||||
|
|
||||||
|
Such as `yum` or `dnf`...
|
||||||
|
|
||||||
.. code-block:: console
|
.. code-block:: console
|
||||||
|
|
||||||
$ yum install validations-common
|
$ yum|dnf install validations-common
|
||||||
|
|
||||||
|
|
||||||
or the more modern `dnf`.
|
or the more modern `dnf`.
|
||||||
@ -73,9 +74,6 @@ While the validations-common can be run by itself,
|
|||||||
it nonetheless depends on Ansible and validations-libs.
|
it nonetheless depends on Ansible and validations-libs.
|
||||||
Therefore it isn't recommended to use only validations-common.
|
Therefore it isn't recommended to use only validations-common.
|
||||||
|
|
||||||
The validations included with validations-common are intended to be demonstrations,
|
|
||||||
capable of running on most setups. But they are not meant for production environment.
|
|
||||||
|
|
||||||
.. _virtualenvwrapper: https://pypi.org/project/virtualenvwrapper/
|
.. _virtualenvwrapper: https://pypi.org/project/virtualenvwrapper/
|
||||||
.. _Apache_license: http://www.apache.org/licenses/LICENSE-2.0
|
.. _Apache_license: http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
|||||||
@ -1,36 +1,5 @@
|
|||||||
============
|
=========================
|
||||||
Contributing
|
So You Want To Contribute
|
||||||
============
|
=========================
|
||||||
|
|
||||||
.. include:: ../../CONTRIBUTING.rst
|
.. include:: ../../CONTRIBUTING.rst
|
||||||
|
|
||||||
Communication
|
|
||||||
-------------
|
|
||||||
* IRC channel ``#validation-framework`` at `Libera`_ (For all subject-matters)
|
|
||||||
* IRC channel ``#tripleo`` at `OFTC`_ (OpenStack and TripleO discussions)
|
|
||||||
|
|
||||||
.. _Libera: https://libera.chat/
|
|
||||||
.. _OFTC: https://www.oftc.net/
|
|
||||||
|
|
||||||
Contributor License Agreement
|
|
||||||
-----------------------------
|
|
||||||
|
|
||||||
.. index::
|
|
||||||
single: license; agreement
|
|
||||||
|
|
||||||
In order to contribute to the validations-common project, you need to have
|
|
||||||
signed OpenStack's contributor's agreement.
|
|
||||||
|
|
||||||
.. seealso::
|
|
||||||
|
|
||||||
* https://docs.openstack.org/infra/manual/developers.html
|
|
||||||
* https://wiki.openstack.org/wiki/CLA
|
|
||||||
|
|
||||||
Project Hosting Details
|
|
||||||
-----------------------
|
|
||||||
|
|
||||||
Code Hosting
|
|
||||||
https://opendev.org/openstack/validations-common
|
|
||||||
|
|
||||||
Code Review
|
|
||||||
https://review.opendev.org/#/q/status:open+project:openstack/validations-common,n,z
|
|
||||||
|
|||||||
@ -12,7 +12,6 @@ Contents:
|
|||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
readme
|
readme
|
||||||
installation
|
|
||||||
usage
|
usage
|
||||||
contributing
|
contributing
|
||||||
roles
|
roles
|
||||||
|
|||||||
@ -1,43 +0,0 @@
|
|||||||
============
|
|
||||||
Installation
|
|
||||||
============
|
|
||||||
Recommended process
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
There are several different ways to install validations-common.
|
|
||||||
However it is **recommended** to both install and use
|
|
||||||
the package inside python virtual environment.
|
|
||||||
|
|
||||||
At the command line using `pip`.
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ pip install validations-common
|
|
||||||
|
|
||||||
|
|
||||||
Or, if you have virtualenvwrapper_ installed.
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ mkvirtualenv validations-common
|
|
||||||
$ pip install validations-common
|
|
||||||
|
|
||||||
Installation with package manager
|
|
||||||
---------------------------------
|
|
||||||
Alternativelly it is possible to install validations-common using package manager.
|
|
||||||
|
|
||||||
Such as `yum`...
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ yum install validations-common
|
|
||||||
|
|
||||||
|
|
||||||
or the more modern `dnf`.
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ dnf install validations-common
|
|
||||||
|
|
||||||
|
|
||||||
.. _virtualenvwrapper: https://pypi.org/project/virtualenvwrapper/
|
|
||||||
Loading…
Reference in New Issue
Block a user