Skip to content

Commit

Permalink
Adding Governance page
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul Meems committed Mar 7, 2019
1 parent d1b12a2 commit 57a6012
Show file tree
Hide file tree
Showing 4 changed files with 214 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/source/_static/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
}

.wy-side-scroll {
width: 300px;
width: auto;
overflow-y: auto;
}

Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 45 additions & 0 deletions docs/source/_templates/footer.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<footer>
{% if (theme_prev_next_buttons_location == 'bottom' or theme_prev_next_buttons_location == 'both') and (next or prev) %}
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
{% if next %}
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}" accesskey="n" rel="next">{{ _('Next') }} <span class="fa fa-arrow-circle-right"></span></a>
{% endif %}
{% if prev %}
<a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> {{ _('Previous') }}</a>
{% endif %}
</div>
{% endif %}

<hr/>

<div role="contentinfo">
<p>

&copy; Copyright 2018-2019, Global Coffee Platform, licensed under a a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.

{%- if build_id and build_url %}
{% trans build_url=build_url, build_id=build_id %}
<span class="build">
Build
<a href="{{ build_url }}">{{ build_id }}</a>.
</span>
{% endtrans %}
{%- elif commit %}
{% trans commit=commit %}
<span class="commit">
Revision <code>{{ commit }}</code>.
</span>
{% endtrans %}
{%- elif last_updated %}
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
{%- endif %}

</p>
</div>

{%- if show_sphinx %}
{% trans %}Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %}.
{%- endif %}

{%- block extrafooter %} {% endblock %}
</footer>
170 changes: 168 additions & 2 deletions docs/source/governance.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,170 @@
**********
Governance
==========
**********

See https://github.com/ThreeSixtyGiving/standard/blob/master/documentation/governance.md for an example.
.. Based on https://github.com/ThreeSixtyGiving/standard/blob/master/documentation/governance.md for an example.
============
Introduction
============
For the majority of coffee farmers, growing coffee is not a viable business. The coffee world is also a very fragmented one.
There are 20 to 25 million producers scattered throughout 50 to 60 different countries. There are also hundreds of traders, roasters, retailers,
NGOs, governments, donors, and sustainability initiatives all trying to pursue their own sustainability agendas and activities regardless of duplication, short-term focused or fragmentation.

Which is why over 150 leading coffee companies and organizations from every corner of the coffee world came together to establish a
central platform which can more effectively coordinate the $350 Million spent annually on sustainability and, through collective action,
achieve far greater impact on the livelihoods of coffee farming families and their communities than by doing it alone.

The Global Coffee Data Standard displays the initial basic Indicators for farm-level coffee sustainability, as originally determined by the GCP and the SPF Indicator Working Group.
COSA–with feedback from the members of the Global Expert Committee–developed and synthesized practical metrics to operationalize the indicators so they can be functional across origins and comparable over time.
The approach builds on global experience refined with tens of thousands of surveys and the expertise of the Committee members.

As the Global Coffee Data Standard develops over time, with updated versions and new publishers, it is important that a diverse group of stakeholders are engaged in the process.

This document outlines the governance and revision processes for the Global Coffee Data Standard. It was agreed at a Standard Stewardship Committee meeting on 12th February 2019.
The Stewardship Committee must be consulted before any changes are made either to this document or to the governance and revision processes for the Global Coffee Data Standard.

======================
Version 1.0 and Beyond
======================
The Global Coffee Data Standard was initially developed through an iterative process in 2017 & 2018, resulting in an initial draft version in November 2018.

During 2019, we have been working towards a first version of the Standard, version 1.0. Our work has focused on addressing some issues identified through wider adoption of the Standard during 2019 and 2020.

This document outlines a process for managing changes to the Global Coffee Data Standard during the move from a draft version to an officially agreed version, which will be numbered 1.0.

==========================
Stewardship and Governance
==========================
On May 1st 2016 the Global Coffee Platform (GCP) launched, and acts as the lead steward of the Global Coffee Data Standard.

The organisation is led by a Chief Executive Officer (CEO) who is supported by a staff team as well as a technical team.
The organisation’s activities and governance is overseen by a Board of Directors that includes representatives from across the charitable giving sector.

In the pursuit of openness and community-driven process, subscribers to the Global Coffee Data Standard Forum and
those engaging with the `Global Coffee Data Standard GitHub repository <https://github.com/andrejellema/GlobalCoffeeDataStandard>`_ will be kept informed at all stages about
planned revisions to the 360 Standard, and will be offered clear and timely opportunities to input and comment.

.. TODO :: Will a forum be available?
To ensure the relevance, quality and effective implementation of proposed updates to the Standard, new version releases will be subjected to a process of peer review with
invited reviewers from publisher and user communities, and an open review process.

A Standard Stewardship Committee, made up of representatives from GCP staff and Board members, current and potential publishers, end users and the technical team,
is responsible for giving final approval to formal upgrades of the Standard and ensuring the processes in this document have been properly carried out.

Intellectual property
---------------------
The Global Coffee Data Standard is the intellectual property of GCP. The schema is provided under a `Creative Commons Attribution 4.0 International License <https://creativecommons.org/licenses/by/4.0/>`_.

Contributors to the Standard agree to transfer any copyright in their contributions to GCP, in order that it is held in trust as part of the Standard.
No content infringing upon third-party Intellectual Property Rights will be included in the Standard.

Governance principles
---------------------
We are committed to the `Open Stand principles <https://open-stand.org/about-us/principles/>`_ for standards development. The Global Coffee Data Standard has been developed with:

* **Due process**: Decisions will be made with equity and fairness among participants. Through an open process for submitting issues, extensions and requests for updates, no one party will dominate or guide standard development. All processes will be transparent and opportunities will exist to appeal decisions. Processes for periodic standards review and updating are well defined in this document.

* **Broad consensus**: The process will allow for all views to be considered and addressed, such that agreement can be found across a range of interests.

* **Transparency**: We will provide advance public notice of proposed standards development activities, the scope of work to be undertaken and conditions for participation. Easily accessible records of decisions and the materials used in reaching those decisions will be provided. Public comment periods will be provided before final standards approval and adoption.

* **Balance**: Standard activities will not be exclusively dominated by any particular person, company or interest group.

* **Openness**: The Global Coffee Data Standard processes are open to all interested and informed parties.

==============================
Versioning and Upgrade Process
==============================
Over time, changes will be needed to the Standard, including addition of new codes and fields, and occasionally involving changes to existing fields and structures.

The revision process will ensure:

* The consequences of any change for different stakeholders are identified and considered; It is clear why changes are needed, and that there is broad support for any proposed changes;

* Changes are easy to identify and are transparent, and publishers, users and intermediaries have clear documentation to allow them to update their data and tools;

* Changes to the Global Coffee Data Standard should be made periodically, with the version number of the standard incremented to indicate that changes have been made, and a change-log maintained.

* That backwards compatibility will be maintained wherever possible.

Versions
--------
**Distinct branches** of the Standard will be maintained within Github for each version. Branches can be in one of two states:

* Development. Both schema and documentation on a development branch can be updated and should only be implemented on an experimental basis.

* Master. Only documentation updates are permitted on a master branch. All documentation changes must be reviewed to ensure they do not make any changes to the meaning of the Standard.

**Semantic Versioning** practices will be used to distinguish between:

* Major versions which make backwards-incompatible API changes; and

* Minor versions which add functionality in a backwards-compatible manner.

These are captured by a version number in the format MAJOR.MINOR

Revision process
----------------
To release a new minor or major version upgrade will involve a number of stages outlined in the flowchart below, and described in more depth in the following sections.

.. image:: _static/images/upgrade_process_march_2019.png
:alt: Revision process

.. todo :: Can/will we adopt the above revision process?
The revision process will follow these general principles:

* **Publicity**: All stages of the revision process will be announced via the GCP online forum. This is the formal channel for notification during the process.

* **Consensus**: The process should act in the interest of the data standard, with particular consideration given to what the changes will mean for current publishers. All processes should aim towards gaining community consensus for changes. In cases where consensus cannot be reached, the process will be escalated to the CEO of GCP and put to a final majority vote by the Stewardship Committee. The GCP technical team are responsible for generating key documentation during the process, but should always be guided by community consensus, submitting all decisions for public discussion.

* **Appeal**: Any party may appeal against decisions made during the process by writing to the Standard Stewardship Committee via the GCP discussion forum. The Stewardship Committee has the authority to reject proposed revisions on the Standard in response to appeals

Proposals
---------
Changes to the Standard can be proposed by anyone at any point via the GCP discussion forum either as issues for discussion, or `pull requests <https://help.github.com/articles/about-pull-requests/>`_ with a clear description of the proposed change.
Contributors are encouraged to raise discussions in order to seek consensus on proposed changes. Changes may be proposed as updated field definitions or codelist entries, or as new features to the Standard.

==============
Prioritisation
==============
The technical team, with reference to community views, identify change proposals and extensions which should be considered for adoption in the next version of the Standard, assigning these to milestones in the issue tracker on GitHub where they are open for discussion.

Periodically, at the start of a revision process a cut-off date for proposals will be announced with at least two weeks’ notice. After that date, a prioritised list of updates is produced. Any new proposed changes received after this period may not be considered until the next prioritisation phase.

Prioritisation review
---------------------
The list is shared on the GCP online forum, with at least a two-week window for discussion.

Based on discussions, a final list is then proposed by the technical team with all the issues that will be taken forward into the rest of the process. A proposal that has made it this far may or may not make it into the final upgrade. As the proposal is worked into final concrete examples and schema changes, further issues may arise that mean the original proposal cannot be implemented.


All reviews and the judgement made will be published. Community members may also submit their own reviews of the whole revision, or specific elements. The minimum period for Committee review is one month.

Revisions
---------
The GCP technical team, with reference to the Standard Stewardship Committee as appropriate, should evaluate reviews and decide whether the whole upgrade, or specific features of it, need to be revised, rejected or postponed to future processes.

If only minor changes are suggested, then the revised Standard can be submitted back to reviewers for a brief review period of at least two weeks. If major changes are required, then a longer follow up review process of at least one month should be allowed for.

Release
-------
Once all reviewer comments have been addressed to the satisfaction of the reviewer in question, then the updated version of the Standard should be submitted to the Standard Stewardship Committee for final approval, along with a short report of the process.

Following Stewardship Committee approval, the revision branch can be set to live.

==================
Deprecation Policy
==================
If a term (an indicator or property) is scheduled to be renamed or removed from the specification as a result of the revision process, the next release of the specification must deprecate the term within the schema, and the following major release must rename or remove the term from the schema, making the term obsolete. Implementations may use deprecated terms, but will receive warnings from the GCP Data Quality tool described below. Implementations may not use obsolete terms, and will receive errors from the Data Quality tool.

==============
Support Policy
==============
Support will be offered for one prior version of the Standard. Support for any earlier versions than this will be ended when a new version is released. For example, when 1.1 is the latest release, 1.0 will be supported in the Data Quality tool and other relevant tools and platforms managed by GCP. When 1.2 is released, support for 1.0 will no longer be guaranteed.

Publishers are encouraged to review each new version when released, and to consider how they might adopt new features. Publishers should aim to move to a new major version within 18 months of its release.

.. todo :: Should we add a privacy page like http://standard.threesixtygiving.org/en/latest/privacy-notice/

0 comments on commit 57a6012

Please sign in to comment.