diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5e06b9a..c76fd41 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# OpenEBS Contributing Guidelines +# OpenEBS Umbrella Contributing Guidelines > [!Important] ->This document is: OpenEBS Contributing Guidelines. OpenEBS is an umbrella project, composed as a federation of individual sub projects (repositories). This document applies to the umbrella project, every sub project and repository in the OpenEBS organization. +> OpenEBS is an "umbrella" project, composed as a federation of individual sub projects (repositories). The umbrella project, every sub project, repository/repo and file in the OpenEBS organization adopts and follows the same set of umbrella policies in the OpenEBS Community repo. This is the Umbrella Contributing Guidelines.
There are many exciting ways you can contribute to OpenEBS ❤️
diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 8842e1e..6b08a3e 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -1,11 +1,11 @@ +# OpenEBS Umbrella Project Governance +> [!Important] +> OpenEBS is an "umbrella" project, composed as a federation of individual sub projects (repositories). The umbrella project, every sub project, repository/repo and file in the OpenEBS organization adopts and follows the same set of umbrella policies in the OpenEBS Community repo. This is the Umbrella Project Governance policy. +
+## Key references: +Please familiarize yourself with our [Project Vision](./VISION.md) and [Contributing Guidelines](./CONTRIBUTING.md). Together with this Governance document, these provide useful info on what and who we are, and how we operate. - -## OpenEBS Project Governance -> [!Important] -> This document is: OpenEBS Project Governance. OpenEBS is an umbrella project, composed as a federation of individual sub projects (repositories). This document applies to both the umbrella project and to every sub-project in the OpenEBS organization. -### Key references docs: -> [Project Vision](./VISION.md)   |   [Values: Mission Statement and Scope](https://github.com/openebs/community/blob/develop/VISION.md#vision-mission-statement-and-scope)   |   [Restraints](./VISION.md#restraints)   |   [Conformance](./VISION.md#conformance)   |   [Contributing: ](./CONTRIBUTING.md) ---
@@ -15,47 +15,35 @@ The **OpenEBS project** is managed on a daily basis by a senior governance & lea > | [Vishnu Attur](https://www.linkedin.com/in/vishnu-attur-5309a333/ "Bengaluru, Karnataka, India (GMT+5:30) Timezone")| :octocat: **[@avishnu](https://github.com/avishnu "Vishnu Govind Attur")** | ![](/images/flags/de_je/in.png) | **Admin**, ```Maintainer``` | > | [Abhinandan Purkait](https://www.linkedin.com/in/abhinandan-purkait/ "Bengaluru, Karnataka, India (GMT+5:30) Timezone") | :sunglasses: **[@Abhinandan-Purkait](https://github.com/Abhinandan-Purkait "Abhinandan Purkait")** | ![](/images/flags/de_je/in.png) | ```Maintainer``` | > | [Niladri Halder](https://www.linkedin.com/in/niladrih/ "Bengaluru, Karnataka, India (GMT+5:30) Timezone") | :rocket: **[@niladrih](https://github.com/niladrih "Niladrih Halder")** | ![](/images/flags/de_je/in.png) | ```Maintainer``` | -> | [Ed Robinson](https://www.linkedin.com/in/edrob/ "San Francisco, USA (GMT-7) Timezone") | :heart: **[@edrob999](https://github.com/edrob999 "Ed Robinson")** | ![](/images/flags/ni_tn/nz.png) | **CNCF Primary Liason** | +> | [Ed Robinson](https://www.linkedin.com/in/edrob/ "San Francisco, USA (GMT-7) Timezone") | :dog: **[@edrob999](https://github.com/edrob999 "Ed Robinson")** | ![](/images/flags/ni_tn/nz.png) | **CNCF Primary Liaison**,```Special Maintainer``` | > | [Tiago Castro](https://www.linkedin.com/in/tiago-castro-3311453a/ "London, UK (GMT+1) Timezone") | :zap: **[@tiagolobocastro](https://github.com/tiagolobocastro "Tiago Castro")** | ![](/images/flags/ni_tn/pt.png)   ![](/images/flags/de_je/gb.png) | **Admin**, ```Maintainer``` | > | [David Brace](https://www.linkedin.com/in/dbrace/ "San Francisco, USA (GMT-7) Timezone") | :star: **[@orville-wright](https://github.com/orville-wright "Dave Brace")** | ![](/images/flags/ni_tn/nz.png)   ![](/images/flags/de_je/hu.png)   ![](/images/flags/to_zw/us.png) | **Admin**, ```Maintainer``` |
-### Steering Committee, Admin, Maintainers, Contributors and Adopters +## Org Admin, Maintainers, Contributors and Adopters -The OpenEBS project has four core roles. All project functions are/must fit into (and are goverened by hese roles:
+The OpenEBS project has four core roles. All project members operate in one (or more) of these roles: +
| Level | Member type | Example description, scope and role | | :--- | :--- | :--- | -| 1 | **Steering Committee** | Sets project governance, operating guidelines and provides oversight. Steering committee members are elected or removed by the current steering committee. Steering Committee members authority applies to the OpenEBS organization and every sub-project in the organization. | -| 2 | **Maintainers** | Roadmap, contribution guidelines, Review, Approve/Reject, Merge, Manage repos. Maintainers are elected or removed by the current maintainers, appointed or removed by the steering committee. A maintainer’s authority applies to the OpenEBS organization and every sub-project in the organization; unless they have been appointed as a [special maintainer](#special-projects-and-special-maintainers) | -| 3 | **Contributors:** | Contribute code, testing, documentation to the project. A contributor’s authority applies to one or more sub projects. | -| 4 | **Adopters:** | Use the OpenEBS product without contributing to the project. An adopter has authority to raise issues, participate in discussions on sub projects with a public forum. | - +| 1 | **Org Admin** | Administer organization in GitHub, add/subtract admins, invite members, manage org and repo integrations. | +| 2 | **Maintainers** | Develop roadmap, contribution guidelines; Review, Approve/Reject, Merge, Manage repos. Maintainers are elected or removed by the current maintainers. A maintainer’s authority applies to the OpenEBS organization and every sub-project in the organization; unless they have been appointed as a [special maintainer](#special-projects-and-special-maintainers) | +| 3 | **Contributors:** | Contribute code, test, document the project. A contributor’s authority applies to one or more sub projects. | +| 4 | **Adopters:** | Use the OpenEBS product without contributing to the project. An adopter has authority to raise issues, participate in discussions on sub projects within a public forum. |
- These roles are described in more detail below: -### Steering Committee -The steering committee is in charge of setting the OpenEBS project operating procedures: -* [Project Vision](./VISION), mission statement and scope, restraints conformance guidelines as recorded in the OpenEBS Vision document -* [Product Governance](./GOVERNANCE) as recorded in this document -* Assigning or removing maintainers - -The steering committee is composed of one or more representatives from organizations with significant investment in the OpenEBS project (eligible organizations). Eligible organizations are: - -* [DataCore Software (DataCore)](https://datacore.com) -* [Cloud Native Computing Foundation (CNCF)](https://cncf.io) - -An eligible organization may assign one member to the Steering committee. The steering committee meets as needed, and may vote to assign or remove other members or to make changes to the operating procedures. Unless otherwise agreed by the Steering Committee, a vote is carried with a ⅔ majority of votes in favor. Voting is in private, with decisions recorded in “Appendix 1: Steering Committee Members and Decisions” section of this document. - -If the Steering Committee remains deadlocked on a vote, they agree to enter mediation with a mutually agreed mediation authority, and abide by the mediator’s decision. +### Org Admin +The org admins are a group that primarilly performs the non-code-related Github tasks such as updating permissions, configuring integrations and other administration tasks. The admins are informally appointed by the maintainers or by other org admins. +
### Maintainers -Maintainers are an elected or assigned group that share responsibility in the OpenEBS project success. They have made a long-term, recurring time investment to improve the project, and spend their time doing what needs to be done, not necessarily what is the most interesting or fun. Maintainers of the project are people the community can depend on and trust to make decisions in the best interest of the project. Anyone wanting to become a maintainer is expected to be deeply involved in contributing code, pull request review, and triage of issues in the project for more than three months. +Maintainers are an elected group that share responsibility in the OpenEBS project success. They have made a long-term, recurring time investment to improve the project, and spend their time doing what needs to be done, not necessarily what is the most interesting or fun. Maintainers of the project are people the community can depend on and trust to make decisions in the best interest of the project. Anyone wanting to become a maintainer is expected to be deeply involved in contributing code, pull request review, and triage of issues in the project for more than three months. -A maintainer has authority over all sub projects within the OpenEBS organization, and have responsibility for: +Maintainers have authority over all sub projects within the OpenEBS organization, with responsibility for: * Project roadmap, * Reviewing, approving and denying contributions, @@ -102,14 +90,14 @@ OpenEBS welcomes people who simply want to Adopt the OpenEBS product, and welcom ## Special Projects and Special Maintainers All sub projects within the OpenEBS organization abide by the common umbrella governance and policies, and a maintainer has authority over all sub projects, with these exceptions. -The OpenEBS maintainers may elect, or the Steering Committee may assign: +The OpenEBS maintainers may elect: * A “special maintainer” for one or more sub projects (typically where the individual has specialist knowledge for a discrete area of the project) * A “special project” that operates with deviation from the common umbrella governance and rules. The deviations are listed in the project’s README.md. -Special projects and special maintainers are appointed or removed by the Steering Committee at their discretion, or elected and removed by a Maintainers vote (requiring 50% for election, and ⅔ for removal). +Special projects and special maintainers are elected and removed by a Maintainers vote (requiring 50% for election, and ⅔ for removal). -Special Projects and Special Maintainers are listed in the section “Appendix 2: Special Projects and Special Maintainers” +Special Projects and Special Maintainers are listed in the section “Appendix 1: Special Projects and Special Maintainers” ## Adding and Removing Sub Projects @@ -127,13 +115,10 @@ Also see: MAINTAINERS file ## Conflict Resolution If you have a technical dispute that you feel has reached an impasse with a subset of the community, any contributor may open an issue, specifically calling for a resolution vote of the current maintainers to resolve the dispute. The same voting quorums required (2/3) for removing maintainers will apply to conflict resolution. +## Modifying this document +Changes to this policy and any supporting documents must be agreed and approved by 2/3 of the Maintainers either by vote, or by review and approval of a PR on the document. -## Appendix 1: Steering Committee Members and Decisions - -Members: - - -### Record of Decisions +## Appendix 1: Special Projects and Special Maintainers +* Ed Robinson, Special Maintainer for OpenEBS/Community repo -## Appendix 2: Special Projects and Special Maintainers diff --git a/VISION.md b/VISION.md index 9032ae6..a380fe1 100644 --- a/VISION.md +++ b/VISION.md @@ -1,8 +1,10 @@ -# OpenEBS Project Vision +# OpenEBS Umbrella Project Vision + > [!Important] -> This document is: OpenEBS Project Vision. A foundation document for the OpenEBS project. OpenEBS Project Governance. OpenEBS is an umbrella project, composed as a federation of individual sub projects (repositories). This document applies to both the umbrella project and to every sub project in the OpenEBS organization. -
-OpenEBS (Open-Elastic-Block-Storage) aims to provide fast, resilient, available, enterprise-grade storage; natively inside a Kubernetes cluster as Hyper-Converged storage. OpensEBS Users provision OpenEBS storage services to Kubernetes applications running natively inside a Kubernetes cluster. +> OpenEBS is an "umbrella" project, composed as a federation of individual sub projects (repositories). The umbrella project, every sub project, repository/repo and file in the OpenEBS organization adopts and follows the same set of umbrella policies in the OpenEBS Community repo. This is the Umbrella Vision for OpenEBS. +
+ +OpenEBS (Open-Elastic-Block-Storage) aims to provide fast, resilient, available, enterprise-grade storage; natively inside a Kubernetes cluster as Hyper-Converged storage. OpenEBS Users provision OpenEBS storage services to Kubernetes applications running natively inside a Kubernetes cluster. In this document we present the project: * Vision, Mission Statement and Scope @@ -28,7 +30,7 @@ In this document we present the project:
> [!IMPORTANT] -> With OpenEBS users can attach an storage media (any block-mode storage device) to a node, and assign it to be managed by OpenEBS; where the system can be configured to provide access to provisioned Storage volumes across any container within the cluster. You can address block devices across nodes and create volume snapshots/clones. You can set up Highly flexible local volumes and expand the volume and filesystem while online. You can trust OpenEBS whether you are a hobbyist programmer, small business or large enterprise. +> With OpenEBS, users can attach an storage media (any block-mode storage device) to a node, and assign it to be managed by OpenEBS; where the system can be configured to provide access to provisioned Storage volumes across any container within the cluster. You can address block devices across nodes and create volume snapshots/clones. You can set up Highly flexible local volumes and expand the volume and filesystem while online. You can trust OpenEBS whether you are a hobbyist programmer, small business or large enterprise.
### Scope @@ -97,7 +99,7 @@ DataCore, Inc is a CNCF Silver member. DataCore support's CNCF extensively and f ## Conformance The OpenEBS project produces the OpenEBS product referred to as **```Open Source STANDARD```** (OSS).
-Many commercial and non-commercial vendors have incorporated, or wish to incorporate a version of OpenEBS as a component or integrated service within their own product offering, including Microsoft Azure, DataCore and Civo. [see ADOPTERS file](https://github.com/openebs/openebs/blob/main/ADOPTERS.md) +Many commercial and non-commercial vendors have incorporated, or wish to incorporate a version of OpenEBS as a component or integrated service within their own product offering, including Microsoft Azure, DataCore and Civo. [see ADOPTERS file](./ADOPTERS.md) The OpenEBS project and CNCF recognize the importance of supporting this, and maintain a conformance program for vendors to use OpenEBS technology, and OpenEBS marks. @@ -110,4 +112,4 @@ The [OpenEBS GitHub organization](https://github.com/openebs) has multiple repos > The OpenEBS project Leadership/Maintainers also administer the affiliated [**OpenEBS-archive organization**](https://github.com/openebs-archive).
> 1. This parallel organization is **OWNED by CNCF** and administrated as a reference archive for OpenEBS ```Legacy``` and ```Deprecated``` OpenEBS repositories, assets, IP, source code, dependencies and resources.
> 2. From time to time, we reserve then right to selectively Deprecate and Archive OpenEBS components and physically migrate them **```out-of```** the OpenEBS Parent project; and into the Archive organization. This process **```officially removes```** those OpenEBS components from the parent OpenEBS project/product. All entities held within the Archive org are **NO LONGER** an active component of the OpenEBS Parent project/product.
-> 3. The Archive org is **NOT** intended for active code or community contributions. The [Project Rules and Governance](./GOVERNANCE.md) also apply to the OpenEBS-archive organization, unless explicitly stated otherwise in the OpenEBS-archive organization README.
\ No newline at end of file +> 3. The Archive org is **NOT** intended for active code or community contributions. The [Project Rules and Governance](./GOVERNANCE.md) also apply to the OpenEBS-archive organization, unless explicitly stated otherwise in the OpenEBS-archive organization README.