From 911c90569ccb09ecf0d7aa11a5a707c8ebda09cf Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Thu, 13 May 2021 09:55:44 -0500 Subject: [PATCH] [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 --- CONTRIBUTING.rst | 19 +++++++++ doc/source/_static/cloudkitty.conf.sample | 19 +++++---- doc/source/contributor/contributing.rst | 48 +++++++++++++++++++++++ doc/source/index.rst | 7 ++++ doc/source/pdf-index.rst | 8 ++++ 5 files changed, 94 insertions(+), 7 deletions(-) create mode 100644 CONTRIBUTING.rst create mode 100644 doc/source/contributor/contributing.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000..72cc0728 --- /dev/null +++ b/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 diff --git a/doc/source/_static/cloudkitty.conf.sample b/doc/source/_static/cloudkitty.conf.sample index 9c00a17b..5cc203bd 100644 --- a/doc/source/_static/cloudkitty.conf.sample +++ b/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) diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 00000000..09d54a1c --- /dev/null +++ b/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 `_ 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 +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +Cloudkitty features are tracked on `Storyboard `_. + +Task Tracking +~~~~~~~~~~~~~ +We track our tasks in `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. + +Reporting a Bug +~~~~~~~~~~~~~~~ +You found an issue and want to make sure we are aware of it? You can do so on +`StoryBoard `_. + +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 +`_. diff --git a/doc/source/index.rst b/doc/source/index.rst index a486606f..d5ebb57d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -35,6 +35,13 @@ Documentation contents developer/index + * - **Contributors** + + - .. toctree:: + :maxdepth: 2 + + contributor/contributing + * - **API Reference** - .. toctree:: :maxdepth: 2 diff --git a/doc/source/pdf-index.rst b/doc/source/pdf-index.rst index a64ac24e..47f3a965 100644 --- a/doc/source/pdf-index.rst +++ b/doc/source/pdf-index.rst @@ -33,6 +33,14 @@ Developer developer/index +Contributors +------------ + +.. toctree:: + :maxdepth: 2 + + contributor/contributing + API Reference -------------