-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: refactor README, CONTRIBUTING #179
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,76 +1,71 @@ | ||
| # Community Repo Cafe | ||
| # OpenEBS Community | ||
|
|
||
| [](https://www.openebs.io/) | ||
| [](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenebs%2Fcommunity?ref=badge_shield) | ||
| [](https://kubernetes.slack.com/messages/openebs/) | ||
| <BR> | ||
| [](https://www.cncf.io/projects/openebs/) | ||
| [](./LICENSE) | ||
| [](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fopenebs%2Fopenebs?ref=badge_shield&issueType=license) | ||
| [](https://clomonitor.io/projects/cncf/openebs) | ||
| [](https://kubernetes.slack.com/messages/openebs) | ||
| [](https://us05web.zoom.us/j/87535654586?pwd=CigbXigJPn38USc6Vuzt7qSVFoO79X.1) | ||
| [](https://artifacthub.io/packages/helm/openebs/openebs) | ||
|
|
||
| > [!Important] | ||
| > OpenEBS is an umbrella :open_umbrella: project, composed as a federation of individual sub projects (repositories). The project files in this repository apply to the umbrella project, every sub project, repository and file in the OpenEBS organization. | ||
| <BR> | ||
| > OpenEBS is an umbrella :open_umbrella: project, composed as a federation of individual sub-projects. The project files in this repository apply to the umbrella project and every sub-project in the OpenEBS organization. | ||
|
|
||
| ## About the Community Repo Cafe<BR> | ||
| ## What is OpenEBS | ||
|
|
||
| This Community repository is the ```central location``` for project info and files (like [our GOVERNANCE contract](GOVERNANCE.md) & [our CONTRIBUTING guide](CONTRIBUTING.md) etc) for the OpenEBS organization. You'll also find a [Top level Issues List](https://github.com/openebs/openebs/issues) for Organization related issues that span across products/projects. We also provide a [main Discussions forum](https://github.com/openebs/openebs/discussions) where **```everyone```** can collaborate and discuss anything. | ||
| <BR> | ||
| OpenEBS is an open-source Container Native Storage solution that provides persistent storage for Kubernetes workloads. It enables dynamic provisioning of storage resources using containerized storage controllers, making it highly flexible and cloud-native. OpenEBS supports various storage engines, including LocalPVs for direct node storage and Replicated PV advanced data replication and resilience. It is designed to integrate seamlessly with Kubernetes, offering benefits like storage policies, resize, thin-provisioning, snapshots, and restore capabilities, making it an ideal choice for stateful applications. To read more about OpenEBS, check [here](https://github.com/openebs/openebs/). | ||
|
|
||
| ## Important documents and contacts | ||
| Below are the list of sub-projects: | ||
|
|
||
| This repository contains all the project files for the organization, and the following project files are important for understanding the OpenEBS project, and how we operate: | ||
| - [Local PV Hostpath](https://github.com/openebs/dynamic-localpv-provisioner/) | ||
| - [Local PV ZFS](https://github.com/openebs/zfs-localpv) | ||
| - [Local PV LVM](https://github.com/openebs/lvm-localpv) | ||
| - [Mayastor](https://github.com/openebs/mayastor) | ||
|
|
||
| * [OpenEBS Vision](/VISION.md) Defines the vision, mission statement; what is in-scope and out-of-scope for the project | ||
| * [Governance](/GOVERNANCE.md) How the project operates | ||
| * [Contributing](/CONTRIBUTING.md) How to contribute, guidelines for being a contributor | ||
| <BR> | ||
| ## Who we are | ||
|
|
||
| ## Project Leadership team | ||
| We are a community of innovative Data Storage engineers that contribute to this project. OpenEBS is the result of hundreds of amazing individuals, contributors and storage engineers who provide brainstorming ideas, feedback, code reviews and high-quality code to the project. Anyone who is passionate about storage and data is welcome here. <BR> | ||
|
|
||
| This Community is managed by the OpenEBS ```Maintainers``` and <kbd>**Senior leaders**</kbd> within the OpenEBS project team. We liaise with the Linux Foundation and CNCF on project, governance | ||
| and operational matters. We curate the daily operations of the project, product, roadmaps, initiatives, all engineering/code activities and all events (including conferences). | ||
| <BR> | ||
| ## Community | ||
|
|
||
| ## Who we are | ||
| This Community repository is the ```central location``` for project info and files like our governance, contribution, code of conduct, security and vision for the OpenEBS organization laid out by the Maintainers. You'll also find a [Top level Issues List](https://github.com/openebs/openebs/issues) for Organization related issues that span across products/projects. We also provide a [main Discussions forum](https://github.com/openebs/openebs/discussions) where **```everyone```** can collaborate and discuss anything. | ||
|
|
||
| We are a community of innovative Data Storage engineers that contribute to this project. We are grateful for the major sponsorship provided by [DataCore (also known as DataCore Software)](https://datacore.com), who donate a team of dedicated Dev/QA/Engineers, Product Mgmt, Marketing, Business and Operational leadership as well as significant engineering infrastructure resources and financial funding. Without DataCore OpenEBS would not be the successful product that it is today. OpenEBS is the result of hundreds of amazing individuals, contributors and storage engineers who provide brainstorming ideas, feedback, code reviews and high-quality code to the project. Anyone who is passionate about storage and data is welcome here. <BR> | ||
| - Homepage: [openebs.io](https://openebs.io/) | ||
| - Mailing list: [email protected] | ||
| - Slack: [slack](https://kubernetes.slack.com/messages/openebs) | ||
| - Twitter: [openebs](https://twitter.com/intent/follow?screen_name=openebs) | ||
| - Community Meeting: OpenEBS holds a monthly community meeting via Zoom on the last Thursday of the month, at 14:00 UTC. [Meeting Link](https://us05web.zoom.us/j/87535654586?pwd=CigbXigJPn38USc6Vuzt7qSVFoO79X.1) | ||
| - Community Meeting Recordings: [Youtube](https://www.youtube.com/@openebscommunity6021) | ||
|
|
||
| ## Monthly Community Meetings | ||
| ## Documents | ||
|
|
||
| OpenEBS holds a monthly community meeting via Zoom on the last Thursday of the month, at 14:00 UTC. <BR> | ||
| - [Official Documentation](https://openebs.io/docs) | ||
| - [Governance](./GOVERNANCE.md) | ||
| - [Contributing Guidelines](./CONTRIBUTING.md) | ||
| - [Security Guidelines](./SECURITY.md) | ||
| - [Vision](./VISION.md) | ||
| - [Roadmap Tracker](https://github.com/orgs/openebs/projects/78) | ||
|
|
||
| Meeting Link: <https://us05web.zoom.us/j/87535654586?pwd=CigbXigJPn38USc6Vuzt7qSVFoO79X.1> <BR> | ||
| Starting from August 2024, the meetings are recorded and posted on YouTube: <https://www.youtube.com/@openebscommunity6021> <BR> | ||
| ## Project Leadership team | ||
|
|
||
| ## Code of Conduct | ||
| This Community is managed by the OpenEBS [Maintainers](./MAINTAINERS.md) within the OpenEBS project team. We liaise with the Linux Foundation and CNCF on project, governance | ||
| and operational matters. We curate the operations of the project, product, roadmaps, initiatives, all engineering/code activities and all events (including conferences). | ||
|
|
||
| OpenEBS follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md). | ||
| [<img alt="Container Storage Interface group" src="images/CNCF_csi-horizontal-color_2024.png" width="320">](https://github.com/kubernetes/community/tree/HEAD/sig-storage) [<img alt="Storage Technical Advisory Group" src="images/CNCF_tag-storage-horizontal-color_2024.png" width="320">](https://github.com/cncf/tag-storage)     [<img alt="Cloud Native Community Groups" src="images/CNCF_cncg-icon-color_2024.png" width="200">](https://github.com/cncf/communitygroups) | ||
|
|
||
| --- | ||
| [](https://www.openebs.io/) | ||
| ## How to get involved | ||
|
|
||
| > [!NOTE] | ||
| > CNCF Project status: SANDBOX <BR> | ||
| > ```⚠️``` In Jan 2024, under the guidance of CNCF TOC, our project moved from Sandbox level to Archive level, enabling us to implement an extensive restructuring initiative. We are actively working to archive legacy sub projects, repositories and dependencies to a CNCF owned GitHub organization called: [OpenEBS-Archive](https://github.com/openebs-archive), plus updating our governance and operating procedures.<BR> | ||
| > ```⚠️``` On 13 June 2024, under guidance of CNCF TOC, our project re-Applied for CNCF promotion from ```Archive``` up to ```Sandbox``` level and was accepted back into | ||
| ```Sandbox``` in Oct 2024. See our Sandbox promotion [application here](https://github.com/cncf/sandbox/issues/104) | ||
| > | ||
| > * What's changing in the technology stack? The product team is unifying ``` Five ``` major Storage Engines (<kbd>Mayastor</kbd>, <kbd>LocalPV-LVM</kbd>, <kbd>LocalPV-ZFS</kbd>, <kbd>LocalPV-Hostpath</kbd>, <kbd>RawFile</kbd>) into one core OpenEBS code-base. | ||
| > * For more information, see [the parent issue]( https://github.com/openebs/openebs/issues/3701) in our main repo for more detail. | ||
| > | ||
| <BR> | ||
| One of the easiest ways to contribute is to participate in discussions at community engagements. | ||
|
|
||
| --- | ||
| If you're looking for something to work on, read the [contribution guidelines](./CONTRIBUTING.md) and then you start by looking for GitHub issues, marked with `kind/good-first` or the `kind/help-wanted` labels. | ||
Abhinandan-Purkait marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| [](https://www.datacore.com/) | ||
| OpenEBS is a CNCF project and DataCore is a CNCF Silver member. DataCore supports CNCF extensively and has funded OpenEBS participating in every KubeCon event since 2020. Our project team is managed under the CNCF Storage Landscape and we contribute to the CNCF CSI and TAG Storage project initiatives. We proudly support CNCF Cloud Native Community Groups initiatives.<BR> | ||
| <BR> | ||
| And, we can always use more testing, have more and improved docs, or just write a blog post on what you have discovered whilst using OpenEBS. | ||
|
|
||
| | [<img alt="Container Storage Interface group" src="/images/CNCF_csi-horizontal-color_2024.png" width="320">](https://github.com/kubernetes/community/tree/master/sig-storage) | [<img alt="Storage Technical Advisory Group" src="/images/CNCF_tag-storage-horizontal-color_2024.png" width="320">](https://github.com/cncf/tag-storage) |     [<img alt="Cloud Native Community Groups" src="/images/CNCF_cncg-icon-color_2024.png" width="200">](https://github.com/cncf/communitygroups)| | ||
| | :--- | :---: | ---: | | ||
| ## Code of Conduct | ||
|
|
||
| <BR> | ||
| OpenEBS adopts the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/HEAD/code-of-conduct.md). | ||
|
|
||
| **Thanks for dropping by.\ | ||
| We appreciate everyone in our community and would love to hear from you.** | ||
| This open governance applies to all repos under the `openebs` org. Enjoy coding and collaboration in OSS world! | ||
|
|
||
| ## Activity dashboard | ||
|
|
||
|
|
@@ -79,3 +74,7 @@ We appreciate everyone in our community and would love to hear from you.** | |
| ## License | ||
|
|
||
| [](https://app.fossa.com/projects/git%2Bgithub.com%2Fopenebs%2Fcommunity?ref=badge_large) | ||
|
|
||
| ## OpenEBS is a [CNCF Sandbox Project](https://www.cncf.io/projects/openebs) | ||
|
|
||
|  | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| # Contributing to OpenEBS [Developer Documentation] | ||
|
|
||
| This document describes the process for improving developer documentation by creating PRs at OpenEBS. | ||
|
|
||
| The developer documentation includes anything that will help the community like: | ||
|
|
||
| - Architecture and Design documentation | ||
| - Technical or Research Notes | ||
| - FAQ | ||
| - Process Documentation | ||
| - Generic / Miscellaneous Notes | ||
|
|
||
| We are also looking for an explainer video or presentation from the community that helps new developers in understanding the OpenEBS Architecture, its use cases, and installation procedure locally. | ||
|
|
||
| At a very high level, the process to contributing and improving the code is pretty simple: | ||
|
|
||
| - Submit an issue describing your proposed change | ||
| - Create your development branch | ||
| - Commit your changes | ||
| - Submit your Pull Request | ||
|
|
||
| The following sections describe some guidelines that can come in handy with the above process. | ||
| *Followed by the guidelines, is a [cheatsheet](https://github.com/openebs/openebs/blob/HEAD/contribute/git-cheatsheet.md) with frequently used git commands.* | ||
|
|
||
| ## Submit an issue describing your proposed change | ||
|
|
||
| Some general guidelines when submitting issues for developer documentation: | ||
|
|
||
| - If the proposed change requires an update to the existing page, please provide a link to the page in the issue. | ||
| - If you want to add a new page, then go ahead and open an issue describing the requirement for the new page. | ||
|
|
||
| You can also help with some existing issues under this category available at [developer documentation issues list](https://github.com/openebs/openebs/issues?q=is%3Aopen%20label%3A%22kind%2Fdocumentation%22%20) | ||
|
|
||
| ## Create your development branch | ||
|
|
||
| - Fork the [OpenEBS](https://github.com/openebs/openebs/) repository and if you have forked it already, rebase with develop branch to fetch latest changes to your local system. | ||
| - Create a new development branch in your forked repository with the following naming convention: *"task description-#issue"* | ||
|
|
||
| **Example:** This change is being developed with the branch named: *OpenEBS-DevDoc-PR-Workflow-#213* | ||
|
|
||
| ## Commit your changes | ||
|
|
||
| - Reference the issue number along with a brief description in your commits | ||
| - Set your commit.template to the `COMMIT_TEMPLATE` given in the `.github` directory. | ||
| `git config --local commit.template $GOPATH/src/github.com/openebs/openebs/.github` | ||
Abhinandan-Purkait marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - Signing of the commit is mandatory. | ||
|
|
||
| ## Submit a Pull request | ||
|
|
||
| - Rebase your development branch | ||
| - Submit the PR from the development branch to the openebs/openebs:develop | ||
| - Incorporate review comments, if any, in the development branch. | ||
| - Once the PR is accepted, close the branch. | ||
| - After the PR is merged the development branch in the forked repository can be deleted. | ||
|
|
||
| If you need any help with git, refer to this [git cheat sheet](./git-cheatsheet.md) and go back to the [**contributing to OpenEBS Documentation**](../CONTRIBUTING.md) guide to proceed. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mailing list?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the issue?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A mailing list is like a address book/email group where you register and then the folks who own the group send you emails monthly. E.g.: https://lkml.org/
Ours is a
Maintainers' email.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No this not maintainer's email, there where users are supposed to mail to for queries and stuffs.
Check this https://github.com/cubefs/cubefs?tab=readme-ov-file#community