Skip to content

Commit 06e2ecb

Browse files
authored
docs: enhance readme structure (#216)
Signed-off-by: Mike Ng <ming@redhat.com>
1 parent 0eb50a7 commit 06e2ecb

1 file changed

Lines changed: 68 additions & 21 deletions

File tree

README.md

Lines changed: 68 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,82 @@
11
# Open Cluster Management Community
22

3-
![image](assets/ocm-logo.png)
3+
<div align="center">
44

5-
Welcome to the Open Cluster Management(OCM) community!
5+
![OCM Logo](assets/ocm-logo.png)
66

7-
This is the starting point for joining and contributing to the OCM community - improving docs, improving code, giving talks etc.
7+
[![CNCF Status](https://img.shields.io/badge/CNCF-Sandbox%20Project-blue)](https://www.cncf.io/projects/)
8+
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
9+
[![Release](https://img.shields.io/badge/release-v1.0.0-green.svg)](https://github.com/open-cluster-management-io/ocm/releases)
10+
[![Slack](https://img.shields.io/badge/slack-%23open--cluster--mgmt-brightgreen.svg?logo=slack)](https://kubernetes.slack.com/channels/open-cluster-mgmt)
811

9-
The open-cluster-management.io project is focused on enabling end-to-end visibility and control across your Kubernetes clusters.
12+
**Make working with many Kubernetes clusters super easy regardless of where they are deployed**
1013

11-
Release information can be found here: https://open-cluster-management.io/community/releases/
14+
[Website](https://open-cluster-management.io)[Documentation](https://open-cluster-management.io/getting-started/)[Community](#community)[Contributing](#contributing)
1215

13-
Please read the [MISSION.md](MISSION.md) statement for more information.
16+
</div>
1417

15-
### Community meetings and office hours
18+
## About Open Cluster Management
1619

17-
The community meets on bi-weekly cadence Friday at 01:30 UTC.
18-
The office hours is on bi-weekly cadence Wednesday at 17:00 UTC.
20+
Welcome to the **Open Cluster Management (OCM)** community!
1921

20-
Refer to the meeting calendar for the latest schedule: https://calendar.google.com/calendar/u/0/embed?src=openclustermanagement@gmail.com.
22+
Open Cluster Management is a **CNCF Sandbox project** focused on multicluster and multicloud scenarios for Kubernetes applications. We provide open APIs that are evolving for cluster registration, work distribution, dynamic placement of policies and workloads, and much more.
2123

22-
Meeting Agenda and Topics can be found [here](https://docs.google.com/document/d/1CPXPOEybBwFbJx9F03QytSzsFQImQxeEtm8UjhqYPNg).
23-
24-
Meeting dial-in details, meeting notes and agendas are announced and published to the [open-cluster-management mailing list on Google Groups](https://groups.google.com/g/open-cluster-management).
24+
## Community
2525

26-
### Get connected
26+
### Get Connected
2727

28-
See the following options to connect with the community:
28+
- **[Website](https://open-cluster-management.io)**
29+
- **[Slack](https://kubernetes.slack.com/channels/open-cluster-mgmt)** - Our most popular communication channel!
30+
- **[Mailing List](https://groups.google.com/g/open-cluster-management)**
31+
- **[GitHub Discussions](https://github.com/open-cluster-management-io/community/discussions)**
32+
- **[YouTube Channel](https://www.youtube.com/c/OpenClusterManagement)**
33+
- **[WeChat](COMMUNICATION.md#wechat)** - Ask for an invite in Slack
2934

30-
- [Website](https://open-cluster-management.io)
31-
- [Slack](https://kubernetes.slack.com/channels/open-cluster-mgmt)
32-
- [WeChat](https://github.com/open-cluster-management-io/community/blob/main/COMMUNICATION.md#wechat)
33-
- [Mailing group](https://groups.google.com/g/open-cluster-management)
34-
- [Community meetings and office hours](https://calendar.google.com/calendar/u/0/embed?src=openclustermanagement@gmail.com)
35-
- [YouTube channel](https://www.youtube.com/c/OpenClusterManagement)
35+
### Community Meetings
36+
37+
**[Meeting Calendar](https://calendar.google.com/calendar/u/0/embed?src=openclustermanagement@gmail.com)**
38+
**[Meeting Agenda & Notes](https://docs.google.com/document/d/1CPXPOEybBwFbJx9F03QytSzsFQImQxeEtm8UjhqYPNg)**
39+
40+
## End Users
41+
42+
OCM is being used by companies both large and small. See our [ADOPTERS.md](https://github.com/open-cluster-management-io/ocm/blob/main/ADOPTERS.md) for the full list.
43+
44+
*Are you using OCM? [Share it with us on Slack!](https://kubernetes.slack.com/channels/open-cluster-mgmt)*
45+
46+
## Contributing
47+
48+
We welcome contributions from everyone! Here's how you can get involved:
49+
50+
1. **Read our documentation**:
51+
- [Code of Conduct](CODE_OF_CONDUCT.md)
52+
- [Contributing Guide](CONTRIBUTING.md)
53+
- [Contributor Ladder](CONTRIBUTOR_LADDER.md)
54+
- [Mission Statement](MISSION.md)
55+
56+
2. **Start contributing**:
57+
- Report bugs and request features
58+
- Improve documentation
59+
- Submit code contributions
60+
- Give talks and participate in community events
61+
62+
3. **Join the conversation**:
63+
- Participate in community meetings
64+
- Join discussions on GitHub and Slack
65+
- Help answer questions from other community members
66+
67+
## Governance
68+
69+
Open Cluster Management is governed by a **Steering Committee** and follows a clear **Contributor Ladder**.
70+
71+
- **[Governance](GOVERNANCE.md)** - Complete governance model
72+
- **[Project Structure](GOVERNANCE.md#project-structure)** - Core projects vs subprojects
73+
- **[Contributor Ladder](CONTRIBUTOR_LADDER.md)** - Path to increased involvement
74+
- **[Maintainers](MAINTAINERS.md)** - Current project maintainers
75+
76+
## Resources
77+
78+
- **[Documentation](https://open-cluster-management.io/getting-started/)**
79+
- **[Releases](https://open-cluster-management.io/community/releases/)**
80+
- **[Public Roadmap](https://github.com/open-cluster-management-io/community/projects/2)**
81+
- **[Security](SECURITY.md)** - Security response and reporting
82+
- **[License](LICENSE)** - Apache 2.0

0 commit comments

Comments
 (0)