Add Project Specific Contributor and PTL Docs
This patch amends contributor guidelines for the Ussuri goals. Change-Id: I9207d02a386e1250963b378bd9fd2188d78a613e Task: 38545 Story: 2007236
This commit is contained in:
Roman Gorshunov
parent
24aae696f0
commit
32c7a6cdd4
@ -1,16 +1,19 @@
|
||||
If you would like to contribute to the development of OpenStack,
|
||||
you must follow the steps in this page:
|
||||
The source repository for this project can be found at:
|
||||
|
||||
https://docs.openstack.org/infra/manual/developers.html
|
||||
https://opendev.org/openstack/openstack-helm
|
||||
|
||||
Once those steps have been completed, changes to OpenStack
|
||||
should be submitted for review via the Gerrit tool, following
|
||||
the workflow documented at:
|
||||
Pull requests submitted through GitHub are not monitored.
|
||||
|
||||
https://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||
To start contributing to OpenStack, follow the steps in the contribution guide
|
||||
to set up and use Gerrit:
|
||||
|
||||
Pull requests submitted through GitHub will be ignored.
|
||||
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
|
||||
|
||||
Bugs should be filed as stories in Storyboard, not GitHub:
|
||||
Bugs should be filed on StoryBoard:
|
||||
|
||||
https://storyboard.openstack.org/#!/project/886
|
||||
https://storyboard.openstack.org/#!/project/openstack/openstack-helm
|
||||
|
||||
For more specific information about contributing to this repository, see the
|
||||
openstack-helm contributor guide:
|
||||
|
||||
https://docs.openstack.org/openstack-helm/latest/contributor/contributing.html
|
||||
|
||||
26
README.rst
26
README.rst
@ -12,29 +12,35 @@ on Kubernetes.
|
||||
Communication
|
||||
-------------
|
||||
|
||||
* Join us on `Slack <https://kubernetes.slack.com/messages/C3WERB7DE/>`_ - #openstack-helm
|
||||
* Join us on `IRC <irc://chat.freenode.net:6697/openstack-helm>`_:
|
||||
#openstack-helm on freenode
|
||||
* Community IRC Meetings: [Every Tuesday @ 3PM UTC],
|
||||
#openstack-meeting-4 on freenode
|
||||
* Community `IRC Meetings
|
||||
<http://eavesdrop.openstack.org/#OpenStack-Helm_Team_Meeting>`_:
|
||||
[Every Tuesday @ 3PM UTC], #openstack-meeting-alt on freenode
|
||||
* Meeting Agenda Items: `Agenda
|
||||
<https://etherpad.openstack.org/p/openstack-helm-meeting-agenda>`_
|
||||
* Join us on `Slack <https://kubernetes.slack.com/messages/C3WERB7DE/>`_
|
||||
- #openstack-helm
|
||||
|
||||
Storyboard
|
||||
----------
|
||||
|
||||
Bugs and enhancements are tracked via OpenStack-Helm's `Storyboard <https://storyboard.openstack.org/#!/project_group/64>`_.
|
||||
Bugs and enhancements are tracked via OpenStack-Helm's
|
||||
`Storyboard <https://storyboard.openstack.org/#!/project_group/64>`_.
|
||||
|
||||
Installation and Development
|
||||
----------------------------
|
||||
|
||||
Please review our `documentation <https://docs.openstack.org/openstack-helm/latest/>`_.
|
||||
Please review our
|
||||
`documentation <https://docs.openstack.org/openstack-helm/latest/>`_.
|
||||
For quick installation, evaluation, and convenience, we have a kubeadm
|
||||
based all-in-one solution that runs in a Docker container. The Kubeadm-AIO set
|
||||
up can be found `here <https://docs.openstack.org/openstack-helm/latest/install/developer/index.html>`_.
|
||||
up can be found
|
||||
`here <https://docs.openstack.org/openstack-helm/latest/install/developer/index.html>`_.
|
||||
|
||||
This project is under active development. We encourage anyone interested in
|
||||
OpenStack-Helm to review our `Installation <https://docs.openstack.org/openstack-helm/latest/install/index.html>`_
|
||||
OpenStack-Helm to review our
|
||||
`Installation <https://docs.openstack.org/openstack-helm/latest/install/index.html>`_
|
||||
documentation. Feel free to ask questions or check out our current
|
||||
`Storyboard backlog <https://storyboard.openstack.org/#!/project_group/64>`_.
|
||||
|
||||
@ -49,3 +55,9 @@ Developers wishing to work on the OpenStack-Helm project should always base
|
||||
their work on the latest code, available from the OpenStack-Helm git repository.
|
||||
|
||||
`OpenStack-Helm git repository <https://opendev.org/openstack/openstack-helm/>`_
|
||||
|
||||
Contributing
|
||||
------------
|
||||
|
||||
We welcome contributions. Check out `this <CONTRIBUTING.rst>`_ document if
|
||||
you would like to get involved.
|
||||
|
||||
@ -1,4 +0,0 @@
|
||||
============
|
||||
Contributing
|
||||
============
|
||||
.. include:: ../../CONTRIBUTING.rst
|
||||
107
doc/source/contributor/contributing.rst
Normal file
107
doc/source/contributor/contributing.rst
Normal file
@ -0,0 +1,107 @@
|
||||
============================
|
||||
So You Want to Contribute...
|
||||
============================
|
||||
|
||||
For general information on contributing to OpenStack, please check out the
|
||||
`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.
|
||||
|
||||
Additional information could be found in
|
||||
`OpenDev Developer's Guide
|
||||
<https://docs.opendev.org/opendev/infra-manual/latest/developers.html>`_.
|
||||
|
||||
Below will cover the more project specific information you need to get started
|
||||
with OpenStack-Helm.
|
||||
|
||||
Communication
|
||||
~~~~~~~~~~~~~
|
||||
.. This would be a good place to put the channel you chat in as a project; when/
|
||||
where your meeting is, the tags you prepend to your ML threads, etc.
|
||||
|
||||
* Join us on `IRC <irc://chat.freenode.net:6697/openstack-helm>`_:
|
||||
#openstack-helm on freenode
|
||||
* Community `IRC Meetings
|
||||
<http://eavesdrop.openstack.org/#OpenStack-Helm_Team_Meeting>`_:
|
||||
[Every Tuesday @ 3PM UTC], #openstack-meeting-alt on freenode
|
||||
* Meeting Agenda Items: `Agenda
|
||||
<https://etherpad.openstack.org/p/openstack-helm-meeting-agenda>`_
|
||||
* Join us on `Slack <https://kubernetes.slack.com/messages/C3WERB7DE/>`_
|
||||
- #openstack-helm
|
||||
|
||||
Contacting the Core Team
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
.. This section should list the core team, their irc nicks, emails, timezones
|
||||
etc. If all this info is maintained elsewhere (i.e. a wiki), you can link to
|
||||
that instead of enumerating everyone here.
|
||||
|
||||
Project's Core Team could be contacted via IRC or Slack, usually during weekly
|
||||
meetings. List of current Cores could be found on a Members tab of
|
||||
`openstack-helm-core <https://review.opendev.org/#/admin/groups/1749,info>`_
|
||||
Gerrit group.
|
||||
|
||||
New Feature Planning
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
.. This section is for talking about the process to get a new feature in. Some
|
||||
projects use blueprints, some want specs, some want both! Some projects
|
||||
stick to a strict schedule when selecting what new features will be reviewed
|
||||
for a release.
|
||||
|
||||
New features are planned and implemented trough the process described in
|
||||
`Project Specifications <../specs/index.html>`_ section of this document.
|
||||
|
||||
Task Tracking
|
||||
~~~~~~~~~~~~~
|
||||
.. This section is about where you track tasks- launchpad? storyboard? is there
|
||||
more than one launchpad project? what's the name of the project group in
|
||||
storyboard?
|
||||
|
||||
We track our tasks on our StoryBoard_.
|
||||
|
||||
If you're looking for some smaller, easier work item to pick up and get started
|
||||
on, search for the 'low-hanging-fruit' tag.
|
||||
|
||||
.. NOTE: If your tag is not 'low-hanging-fruit' please change the text above.
|
||||
|
||||
Other OpenStack-Helm component's tasks could be found on the `group Storyboard`_.
|
||||
|
||||
Reporting a Bug
|
||||
~~~~~~~~~~~~~~~
|
||||
.. Pretty self explanatory section, link directly to where people should report
|
||||
bugs for your project.
|
||||
|
||||
You found an issue and want to make sure we are aware of it? You can do so on our
|
||||
Storyboard_.
|
||||
|
||||
If issue is on one of other OpenStack-Helm components, report it to the
|
||||
appropriate `group Storyboard`_.
|
||||
|
||||
Bugs should be filed as stories in Storyboard, not GitHub.
|
||||
|
||||
Getting Your Patch Merged
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
.. This section should have info about what it takes to get something merged. Do
|
||||
you require one or two +2's before +W? Do some of your repos require unit
|
||||
test changes with all patches? etc.
|
||||
|
||||
We require two Code-Review +2's from reviewers, before getting your patch merged
|
||||
with giving Workforce +1. Trivial patches (e.g. typos) could be merged with one
|
||||
Code-Review +2.
|
||||
|
||||
Changes affecting code base often require CI tests and documentation to be added
|
||||
in the same patch set.
|
||||
|
||||
Pull requests submitted through GitHub will be ignored.
|
||||
|
||||
Project Team Lead Duties
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
.. this section is where you can put PTL specific duties not already listed in
|
||||
the common PTL guide (linked below), or if you already have them written
|
||||
up elsewhere you can link to that doc here.
|
||||
|
||||
All common PTL duties are enumerated in the `PTL guide
|
||||
<https://docs.openstack.org/project-team-guide/ptl.html>`_.
|
||||
|
||||
.. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/openstack-helm
|
||||
.. _group Storyboard: https://storyboard.openstack.org/#!/project_group/64
|
||||
@ -6,7 +6,7 @@ Contents:
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
contributing
|
||||
contributor/contributing
|
||||
devref/index
|
||||
gates
|
||||
install/index
|
||||
|
||||
@ -2,7 +2,8 @@
|
||||
Troubleshooting
|
||||
===============
|
||||
|
||||
Sometimes things go wrong. These guides will help you solve many common issues with the following:
|
||||
Sometimes things go wrong. These guides will help you solve many common
|
||||
issues with the following:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
@ -18,12 +19,12 @@ Getting help
|
||||
Channels
|
||||
--------
|
||||
|
||||
* Join us on `Slack <http://slack.k8s.io/>`_ - #openstack-helm
|
||||
* Join us on `IRC <irc://chat.freenode.net:6697/openstack-helm>`_:
|
||||
#openstack-helm on freenode
|
||||
* Join us on `Slack <http://slack.k8s.io/>`_ - #openstack-helm
|
||||
|
||||
Bugs and Feature requests
|
||||
-------------------------
|
||||
|
||||
When discovering a new bug, please report a bug in `Storyboard
|
||||
<https://storyboard.openstack.org/#!/project/886>`_.
|
||||
Please, refer to
|
||||
`Contribution guidelines <../contributor/contributing.html>`_.
|
||||
|
||||
@ -451,7 +451,7 @@ conf:
|
||||
# in a future release, but is available as a temporary backup setting to ensure
|
||||
# compatibility with existing deployments. Further development will not be
|
||||
# done on the legacy experience. Please report any problems with the new
|
||||
# experience via the Launchpad tracking system.
|
||||
# experience via the StoryBoard tracking system.
|
||||
#
|
||||
# Toggle LAUNCH_INSTANCE_LEGACY_ENABLED and LAUNCH_INSTANCE_NG_ENABLED to
|
||||
# determine the experience to enable. Set them both to true to enable
|
||||
|
||||
Loading…
Reference in New Issue
Block a user