diff options
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/conf.py | 25 | ||||
| -rw-r--r-- | doc/source/contributor/contributing.rst | 79 | ||||
| -rw-r--r-- | doc/source/contributor/review_guidelines.rst | 1 | ||||
| -rw-r--r-- | doc/source/index.rst | 9 | ||||
| -rw-r--r-- | doc/source/s3_compat.rst | 4 |
5 files changed, 97 insertions, 21 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 3f048d68f..2ca5d8477 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -29,7 +29,6 @@ import datetime import logging import os -from swift import __version__ import sys # NOTE(amotoki): Our current doc build job uses an older version of @@ -80,15 +79,6 @@ else: now = datetime.date.today() copyright = u'%d, OpenStack Foundation' % now.year -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = __version__.rsplit('.', 1)[0] -# The full version, including alpha/beta/rc tags. -release = __version__ - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None @@ -122,7 +112,7 @@ exclude_trees = [] show_authors = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = 'native' # A list of ignored prefixes for module index sorting. modindex_common_prefix = ['swift.'] @@ -172,11 +162,6 @@ html_theme_options = { # robots.txt. html_extra_path = ['_extra'] -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' -html_last_updated_fmt = '%Y-%m-%d %H:%M' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True @@ -248,6 +233,8 @@ latex_documents = [ latex_use_xindy = False # -- Options for openstackdocstheme ------------------------------------------- -repository_name = 'openstack/swift' -bug_project = 'swift' -bug_tag = '' +openstackdocs_repo_name = 'openstack/swift' +openstackdocs_pdf_link = True +openstackdocs_auto_name = False +openstackdocs_bug_project = 'swift' +openstackdocs_bug_tag = '' diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 000000000..592cf90c8 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,79 @@ +.. include:: ../../../CONTRIBUTING.rst + +Community +========= + +Communication +------------- +IRC + People working on the Swift project may be found in the + ``#openstack-swift`` channel on Freenode during working hours + in their timezone. The channel is logged, so if you ask a question + when no one is around, you can check the log to see if it's been + answered: http://eavesdrop.openstack.org/irclogs/%23openstack-swift/ + +weekly meeting + This is a Swift team meeting. The discussion in this meeting is about + all things related to the Swift project: + +- time: http://eavesdrop.openstack.org/#Swift_Team_Meeting +- agenda: https://wiki.openstack.org/wiki/Meetings/Swift + +mailing list + We use the openstack-discuss@lists.openstack.org mailing list for + asynchronous discussions or to communicate with other OpenStack teams. + Use the prefix ``[swift]`` in your subject line (it's a high-volume + list, so most people use email filters). + + More information about the mailing list, including how to subscribe + and read the archives, can be found at: + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss + +Contacting the Core Team +------------------------ + +The swift-core team is an active group of contributors who are responsible +for directing and maintaining the Swift project. As a new contributor, your +interaction with this group will be mostly through code reviews, because +only members of swift-core can approve a code change to be merged into the +code repository. But the swift-core team also spend time on IRC so feel +free to drop in to ask questions or just to meet us. + +.. note:: + Although your contribution will require reviews by members of + swift-core, these aren't the only people whose reviews matter. + Anyone with a gerrit account can post reviews, so you can ask + other developers you know to review your code ... and you can + review theirs. (A good way to learn your way around the codebase + is to review other people's patches.) + + If you're thinking, "I'm new at this, how can I possibly provide + a helpful review?", take a look at `How to Review Changes the + OpenStack Way + <https://docs.openstack.org/project-team-guide/review-the-openstack-way.html>`_. + + Or for more specifically in a Swift context read :doc:`review_guidelines` + +You can learn more about the role of core reviewers in the OpenStack +governance documentation: +https://docs.openstack.org/contributors/common/governance.html#core-reviewer + +The membership list of swift-core is maintained in gerrit: +https://review.opendev.org/#/admin/groups/24,members + +You can also find the members of the swift-core team at the Swift weekly +meetings. + +Getting Your Patch Merged +------------------------- +Understanding how reviewers review and what they look for will help getting +your code merged. See `Swift Review Guidelines <contributor/review_guidelines>`_ +for how we review code. + +Keep in mind that reviewers are also human; if something feels stalled, then +come and poke us on IRC or add it to our meeting agenda. + +Project Team Lead Duties +------------------------ +All common PTL duties are enumerated in the `PTL guide +<https://docs.openstack.org/project-team-guide/ptl.html>`_. diff --git a/doc/source/contributor/review_guidelines.rst b/doc/source/contributor/review_guidelines.rst new file mode 100644 index 000000000..314e764f4 --- /dev/null +++ b/doc/source/contributor/review_guidelines.rst @@ -0,0 +1 @@ +.. include:: ../../../REVIEW_GUIDELINES.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 9d3023aac..7aeb82e70 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -66,6 +66,15 @@ Overview and Concepts ring_partpower associated_projects +Contributor Documentation +========================= + +.. toctree:: + :maxdepth: 2 + + contributor/contributing + contributor/review_guidelines + Developer Documentation ======================= diff --git a/doc/source/s3_compat.rst b/doc/source/s3_compat.rst index 7ad655cee..04010a7c1 100644 --- a/doc/source/s3_compat.rst +++ b/doc/source/s3_compat.rst @@ -60,8 +60,6 @@ Amazon S3 operations +------------------------------------------------+------------------+--------------+ | `PUT Bucket acl`_ | Core-API | Yes | +------------------------------------------------+------------------+--------------+ -| `Object tagging`_ | Core-API | Yes | -+------------------------------------------------+------------------+--------------+ | `Versioning`_ | Versioning | Yes | +------------------------------------------------+------------------+--------------+ | `Bucket notification`_ | Notifications | No | @@ -78,6 +76,8 @@ Amazon S3 operations +------------------------------------------------+------------------+--------------+ | `Delete Multiple Objects`_ | Advanced Feature | Yes | +------------------------------------------------+------------------+--------------+ +| `Object tagging`_ | Advanced Feature | No | ++------------------------------------------------+------------------+--------------+ | `GET Object torrent`_ | Advanced Feature | No | +------------------------------------------------+------------------+--------------+ | `Bucket inventory`_ | Advanced Feature | No | |