Browse Source

[ussuri][goal] Update contributor documentation

This patch updates/adds the contributor documentation to follow
the guidelines of the Ussuri cycle community goal[1].

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Story: #2007236
Task: #38517
Change-Id: I2ed8113b4a008475ab9526eed9a004bdfcf5d805
changes/56/791256/6
Ghanshyam Mann 3 months ago
committed by Pierre Riteau
parent
commit
911c90569c
  1. 19
      CONTRIBUTING.rst
  2. 19
      doc/source/_static/cloudkitty.conf.sample
  3. 48
      doc/source/contributor/contributing.rst
  4. 7
      doc/source/index.rst
  5. 8
      doc/source/pdf-index.rst

19
CONTRIBUTING.rst

@ -0,0 +1,19 @@
The source repository for this project can be found at:
https://opendev.org/openstack/cloudkitty
Pull requests submitted through GitHub are not monitored.
To start contributing to OpenStack, follow the steps in the contribution guide
to set up and use Gerrit:
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
Bugs should be filed on Storyboard:
https://storyboard.openstack.org/#!/project/890
For more specific information about contributing to this repository, see the
Cloudkitty contributor guide:
https://docs.openstack.org/cloudkitty/latest/contributor/contributing.html

19
doc/source/_static/cloudkitty.conf.sample

@ -94,7 +94,7 @@
#use_eventlog = false
# The amount of time before the log files are rotated. This option is
# ignored unless log_rotation_type is setto "interval". (integer
# ignored unless log_rotation_type is set to "interval". (integer
# value)
#log_rotate_interval = 1
@ -402,8 +402,6 @@
# Maximum number of SQL connections to keep open in a pool. Setting a
# value of 0 indicates no limit. (integer value)
# Deprecated group/name - [DEFAULT]/sql_max_pool_size
# Deprecated group/name - [DATABASE]/sql_max_pool_size
#max_pool_size = 5
# Maximum number of database connection retries during startup. Set to
@ -1212,10 +1210,17 @@
# heartbeat. (integer value)
#heartbeat_rate = 2
# Enable/Disable the RabbitMQ mandatory flag for direct send. The
# direct send is used as reply, so the MessageUndeliverable exception
# is raised in case the client queue does not exist. (integer value)
#direct_mandatory_flag = True
# DEPRECATED: (DEPRECATED) Enable/Disable the RabbitMQ mandatory flag
# for direct send. The direct send is used as reply, so the
# MessageUndeliverable exception is raised in case the client queue
# does not exist.MessageUndeliverable exception will be used to loop
# for a timeout to lets a chance to sender to recover.This flag is
# deprecated and it will not be possible to deactivate this
# functionality anymore (boolean value)
# This option is deprecated for removal.
# Its value may be silently ignored in the future.
# Reason: Mandatory flag no longer deactivable.
#direct_mandatory_flag = true
# Enable x-cancel-on-ha-failover flag so that rabbitmq server will
# cancel and notify consumerswhen queue is down (boolean value)

48
doc/source/contributor/contributing.rst

@ -0,0 +1,48 @@
============================
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.
Below will cover the more project specific information you need to get started
with Cloudkitty.
Communication
~~~~~~~~~~~~~
* IRC channel #cloudkitty at FreeNode
* Mailing list (prefix subjects with ``[cloudkitty]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
Please refer the `Cloudkitty Core Team
<https://review.opendev.org/admin/groups/4ac765c35f985b3ad9226da07fdcc205c1ce4fe1,members>`_ contacts.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
Cloudkitty features are tracked on `Storyboard <https://storyboard.openstack.org/#!/project/890>`_.
Task Tracking
~~~~~~~~~~~~~
We track our tasks in `Storyboard <https://storyboard.openstack.org/#!/project/890>`_.
If you're looking for some smaller, easier work item to pick up and get started
on, search for the 'low-hanging-fruit' tag.
Reporting a Bug
~~~~~~~~~~~~~~~
You found an issue and want to make sure we are aware of it? You can do so on
`StoryBoard <https://storyboard.openstack.org/#!/project/890>`_.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
All changes proposed to the Cloudkitty project require one or two +2 votes
from Cloudkitty 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>`_.

7
doc/source/index.rst

@ -35,6 +35,13 @@ Documentation contents
developer/index
* - **Contributors**
- .. toctree::
:maxdepth: 2
contributor/contributing
* - **API Reference**
- .. toctree::
:maxdepth: 2

8
doc/source/pdf-index.rst

@ -33,6 +33,14 @@ Developer
developer/index
Contributors
------------
.. toctree::
:maxdepth: 2
contributor/contributing
API Reference
-------------

Loading…
Cancel
Save