Skip to content

Commit

Permalink
add governance page
Browse files Browse the repository at this point in the history
  • Loading branch information
onthebreeze committed Jan 5, 2024
1 parent de701e7 commit 2363e2f
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 15 deletions.
42 changes: 37 additions & 5 deletions website/docs/about/Governance.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,43 @@ import Disclaimer from '../\_disclaimer.mdx';

<Disclaimer />

# Governance & Roadmap
# UNTP Governance

## Management process

The UNTP development follows the same **[standard governance rules](https://github.com/uncefact/governance?tab=readme-ov-file#governance)** as any UN/CEFACT project.

* Free to use,
* Open source licensed,
* Maintained via an open process
* Version controlled
* Lifecycle managed


## Releases

As per [docusaurus version management practices](https://docusaurus.io/docs/versioning), the latest stable version of UNTP will always be shown be default at /docs (this site). In-progress future version will be hosted at /docs/next and previous versions at /versioned-docs/version-x.y. The version history includes major versions (breaking) and minor versions (non-breaking but with functional change) but not patch versions (bug fixes and typos) which overwrite the relevant minor version.

The UNTP includes a number of distinct and separately versioned components such as passport schema, traceability event schema and so on. To simplify implementaiton management, all seaprate component versions are grouped together and listed under each aggregated UNTP version.

|UNTP Version| Status| Date| Componenets | Comment|
|------|---|---|---|---|
|0.0.0|![Raw](https://github.com/uncefact/governance/blob/main/images/raw.svg)| 2024-01-01| TBA | First raw documents|
| | | | | |


## Meetings

UNTP development [team meetings](https://us02web.zoom.us/j/85091806131) are held every fortnight from thursday 18 Jan at 7:00am UTC. Each meeting will generally work through open [issues](https://github.com/uncefact/spec-untp/issues) and [pull requests](https://github.com/uncefact/spec-untp/pulls).

|Meeting|Agenda|Summary|Recording|
|2024-01-18|kick-off| TBA | TBA |
| | | | |







protocol : UN ODP
tools : GPL3
lifecycle :
versions : Semver

20 changes: 10 additions & 10 deletions website/docs/about/Requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ This page provides a summary of the high level business requirements for UNTP, g

This set of requirements aim to ensure that UNTP is goverened in an open and transparent manner, is freely avaialable to all, and is extensible to meet specific industry and jurisdictional needs.

|ID | Requirement Statement | Solution Mapping|
|---|---|---|
|GV.01|UNTP development MUST me managed via a transparent and consensus-driven process that is open to contributions from all stakeholders - so that implementers can have confidence that the UNTP will meet their requirements. | [Governance](Governance.md) |
|GV.02|The UNTP IP MUST be owned by the UN and be permanently free to access and free to use - so that implementers can have confidence that there will never be any fees for use or IP infringement claims. | [Governance](Governance.md) |
|GV.03|New versions of UNTP SHOULD be backwards compatible with earlier versions and each version MUST remain active and supported for a minimum of 2 years - so that implementers can have confidence in the durability of their investment.| [Governance](Governance.md) |
|GV.04|UNTP implementation tools including reference implementations and test services MUST be available under open source and royalty free licensing - so that implementers can confidently use the tools to minimise their own implementation costs | [Tools & Support](../tools-and-support/index.md)|
|GV.05|The UNTP MUST define a non-breaking extensions methodology - so that UNTP can be extended to meet specific jurisdictional or industry requirements and so that implementers of a registered extension can be confident that their implementation is interoperable with UNTP core. | [Extensions](../extensions/index.md)|
|GV.06|Industry and/or jurisdictional extensions to the UNTP SHOULD also be governed via an open process and released under royalty free license terms - so that implementers of extensions can have same fees & IP confidence as with UNTP core.|[Extensions](../extensions/index.md)|
|GV.07|UNTP MUST provide a mechanism for implementers to pledge their support and to register their implementations - so that implementers can choose to register both their sustainability commitment and conformant solutions for discovery by a global community of users and/or customers.|[Implementations](../implementations/index.md)|
|ID | Name| Requirement Statement | Solution Mapping|
|---|---|---|---|
|GV.01|Consensus driven process|UNTP development MUST me managed via a transparent and consensus-driven process that is open to contributions from all stakeholders - so that implementers can have confidence that the UNTP will meet their requirements. | [Governance](Governance.md) |
|GV.02|Freely available|The UNTP IP MUST be owned by the UN and be permanently free to access and free to use - so that implementers can have confidence that there will never be any fees for use or IP infringement claims. | [Governance](Governance.md) |
|GV.03|Backwards compatible|New versions of UNTP SHOULD be backwards compatible with earlier versions and each version MUST remain active and supported for a minimum of 2 years - so that implementers can have confidence in the durability of their investment.| [Governance](Governance.md) |
|GV.04|Open source|UNTP implementation tools including reference implementations and test services MUST be available under open source and royalty free licensing - so that implementers can confidently use the tools to minimise their own implementation costs | [Tools & Support](../tools-and-support/index.md)|
|GV.05|Extensible|The UNTP MUST define a non-breaking extensions methodology - so that UNTP can be extended to meet specific jurisdictional or industry requirements and so that implementers of a registered extension can be confident that their implementation is interoperable with UNTP core. | [Extensions](../extensions/index.md)|
|GV.06|Reusable extensions|Industry and/or jurisdictional extensions to the UNTP SHOULD also be governed via an open process and released under royalty free license terms - so that implementers of extensions can have same fees & IP confidence as with UNTP core.|[Extensions](../extensions/index.md)|
|GV.07|Implementation pledge|UNTP MUST provide a mechanism for implementers to pledge their support and to register their implementations - so that implementers can choose to register both their sustainability commitment and conformant solutions for discovery by a global community of users and/or customers.|[Implementations](../implementations/index.md)|


## Architectural Requirements
Expand Down Expand Up @@ -111,7 +111,7 @@ This set of requirements aim to ensure that UNTP is implementable at the lowest
|IM.04|Implementation Support |UNTP MUST provide mechanisms for implementers to get either community support or professional support so that they can minimise their implementation risk. | [Support](../tools-and-support/Support.md)|
|IM.05|Tracking implementations|UNTP MUST provide a mechanism to track implementations so that uptake and impact can be measured and so that early implementers can publicise their solutions. | [Implementations](../implementations/index.md) |
|IM.06|Tracking extensions |UNTP MUST provide a mechansim to track and publish industry & jurisdictional extensions so that new extensions can find and re-use relevant work. |[Extensions](../extensions/index.md) |
|IM.07|Greenwashing KPIs|Although uptake is a simple and concrete success measure, the real purpose of UNTP is to lift the value of sustainable practices by countering greenwashing. Therefore, UNTP MUST develop a set of KPIs that can be tracked to assess whether UNTP is having a material impact. | |
|IM.07|Greenwashing KPIs|Although uptake is a simple and concrete success measure, the real purpose of UNTP is to lift the value of sustainable practices by countering greenwashing. Therefore, UNTP MUST develop a set of greenwashing KPIs that can be tracked to assess whether UNTP is having a material impact. | Greenwashing KPIs|



0 comments on commit 2363e2f

Please sign in to comment.