Skip to content

Commit

Permalink
chore: refresh docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SparkYuan committed Jan 24, 2024
1 parent 521b832 commit f91c457
Show file tree
Hide file tree
Showing 11 changed files with 100 additions and 827 deletions.
3 changes: 3 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# KusionStack Community Code of Conduct

KusionStack follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).
518 changes: 65 additions & 453 deletions CONTRIBUTING.md

Large diffs are not rendered by default.

161 changes: 0 additions & 161 deletions Documentation-Review-Process.md

This file was deleted.

14 changes: 14 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# KusionStack Maintainers

The following is the list of maintainers for all KusionStack repositories, in alphabetical order:

- Dayuan Li [@SparkYuan](https://github.com/SparkYuan)
- Haoming Liu [@liu-hm19](https://github.com/liu-hm19)
- Jun Zhang [@zoumo](https://github.com/zoumo)
- Ke Wu [@wu8685](https://github.com/wu8685)
- Shuai Pan [@panshuai-ps](https://github.com/panshuai-ps)
- Yankang Ji [@healthjyk](https://github.com/healthjyk)
- Yingming Yang [@elliotxx](https://github.com/elliotxx)
- Yikun Wang [@Eikykun](https://github.com/Eikykun)
- Zai Chen [@ffforest](https://github.com/ffforest)
- Zibo He [@adohe](https://github.com/adohe)
136 changes: 0 additions & 136 deletions PR-Review-Guide.md

This file was deleted.

55 changes: 16 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,24 @@
# KusionStack community
# Community

Welcome to the KusionStack community!
Welcome to the KusionStack open source community! Your participation is vital for the healthy growth of our open source projects. There are several ways you can get involved. You can create issues or fix bugs, improve documentation, or contribute code by submitting pull requests (PRs). The KusionStack project is always looking for new contributors and feedback. To get in touch, please refer to the links below.

This is the starting point for becoming a contributor - improving code and docs, giving talks, etc.
* [Open a New Discussion on GitHub](https://github.com/orgs/KusionStack/discussions)
* [Contact Us on Slack](https://app.slack.com/client/T03H6QE4VL0/setup-welcome)

## KusionStack Open Day
# CONTRIBUTING

- [2022/open-day/README.md](2022/open-day/README.md)
We appreciate contributions from the community! To submit changes, please refer to the contributing file in the corresponding KusionStack repository. The files are available at the following links:
* [Kusion](https://github.com/KusionStack/kusion/blob/main/docs/contributing.md)
* [Operating](https://github.com/KusionStack/operating/blob/main/docs/contributing.md)

## Other documents
# CODE OF CONDUCT
To make KusionStack a welcoming and harassment-free experience for everyone, we follow the [KusionStack Code of Conduct](CODE_OF_CONDUCT.md).

- [Community Roles](ROLES.md) - describes the roles individuals can assume within the KusionStack community.
- [Working Groups](WORKING-GROUPS.md) - to enhance community transparency and collaboration among community members, KusionStack created a series of working groups.

## Introduction
# Contact Us
- Twitter: [KusionStack](https://twitter.com/KusionStack)
- Slack: [Kusionstack](https://join.slack.com/t/kusionstack/shared_invite/zt-19lqcc3a9-_kTNwagaT5qwBE~my5Lnxg)
- DingTalk (Chinese): 42753001
- Wechat Group (Chinese)

KusionStack is a Unified Programmable Configuration Tech Stack.


Visit [kusionstack.io](https://kusionstack.io) for more information about using KusionStack.

## KusionStack authors

KusionStack is an open source project started by [Ant Group](https://www.antgroup.com/) with an active development community.

## Community meeting

- Thursday 8:00 PM CST(Beijing 北京时间周四晚 8:00) ([钉钉(DingTalk ID 42753001)](https://h5.dingtalk.com/circle/healthCheckin.html?cbdbhh=qwertyuiop&dtaction=os&4ebe6=d3d59&corpId=ding707e3346ab188ded2040d0a6270bd858)) every other week
- Meeting notes: https://github.com/KusionStack/community/discussions/categories/meeting

## Tutorials

Learn KusionStack with book.

- [KusionStack/kusion-in-action-book](https://github.com/KusionStack/kusion-in-action-book)

## Contributing

See [the contributing document](CONTRIBUTING.md).

## Contact

- [Slack/KusionStack](https://join.slack.com/t/kusionstack/shared_invite/zt-19lqcc3a9-_kTNwagaT5qwBE~my5Lnxg)
- [钉钉(DingTalk ID 42753001)](https://h5.dingtalk.com/circle/healthCheckin.html?cbdbhh=qwertyuiop&dtaction=os&4ebe6=d3d59&corpId=ding707e3346ab188ded2040d0a6270bd858)

![](dingding-talk.jpg)
<img src="https://raw.githubusercontent.com/KusionStack/kusion/main/docs/wx_spark.jpg" width="200" height="200"/>
4 changes: 2 additions & 2 deletions ROLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ This document describes the set of roles individuals may have within the KusionS

## User

A ***user*** is someone that uses KusionStack. They contribute to KusionStack projects by providing feedback to developers in the form of bug reports and feature suggestions. Users participate in the KusionStack community by helping other users.
A ***user*** is someone who uses KusionStack. They contribute to KusionStack projects by providing feedback to developers in the form of bug reports and feature suggestions. Users participate in the KusionStack community by helping other users.

## Contributor

A ***contributor*** is a user who contributes to the project in the form of code or documentation. They take extra steps to participate in a project, are active on the community, participate in discussions, provide patches, documentation, suggestions, and criticism.
A ***contributor*** is a user who contributes to the project in the form of code or documentation. They take extra steps to participate in a project, are active in the community, participate in discussions, and provide patches, documentation, suggestions, and criticism.

## Maintainer

Expand Down
Loading

0 comments on commit f91c457

Please sign in to comment.