mirror of https://github.com/openkruise/kruise.git
docs: better readme to add more details
Signed-off-by: Allen Sun <allensun.shl@alibaba-inc.com>
This commit is contained in:
parent
a1feb49c0a
commit
904bb1ecb8
|
|
@ -0,0 +1 @@
|
|||
# Adopters
|
||||
|
|
@ -0,0 +1 @@
|
|||
# Kruise Changelog
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
# Frequently Asked Questions (FAQ)
|
||||
|
||||
FAQ contains some frequently asked questions about two aspects:
|
||||
|
||||
- First, user-facing functionalities.
|
||||
- Second, underlying concept and thoery.
|
||||
|
||||
Techinical questions will not be included in openkruise/kruise's FAQ.
|
||||
|
||||
## Advanced Statefulset
|
||||
|
||||
To be added.
|
||||
|
||||
## Sidecar Set
|
||||
|
||||
To be added.
|
||||
|
||||
## Broadcast Job
|
||||
|
||||
To be added.
|
||||
21
README.md
21
README.md
|
|
@ -5,9 +5,11 @@
|
|||
[](https://codecov.io/gh/openkruise/kruise)
|
||||
[](https://bestpractices.coreinfrastructure.org/en/projects/2908)
|
||||
|
||||
Kruise is the core of the OpenKruise project. It is a set of controllers which extends and complements
|
||||
[Kubernetes core controllers](https://kubernetes.io/docs/concepts/overview/what-is-kubernetes/)
|
||||
on workload management.
|
||||
|Community Meeting|
|
||||
|------------------|
|
||||
|The Kruise Project holds bi-weekly community calls. To join us and watch previous meeting notes and recordings, please see [meeting schedule](https://github.com/openkruise/project/blob/master/MEETING_SCHEDULE.md).|
|
||||
|
||||
Kruise is the core of the OpenKruise project. It is a set of controllers which extends and complements [Kubernetes core controllers](https://kubernetes.io/docs/concepts/overview/what-is-kubernetes/) on workload management.
|
||||
|
||||
Today, Kruise offers three workload controllers:
|
||||
|
||||
|
|
@ -158,10 +160,17 @@ Generate manifests e.g. CRD, RBAC etc.
|
|||
|
||||
## Community
|
||||
|
||||
If you have any questions or want to contribute, you are welcome to join our
|
||||
[slack channel](https://join.slack.com/t/kruise-workspace/shared_invite/enQtNjU5NzQ0ODcyNjYzLWMzZDI5NTM3ZjM1MGY2Mjg1NzU4ZjBjMDJmNjZmZTEwYTZkMzk4ZTAzNmY5NTczODhkZDU2NzVhM2I2MzNmODc).
|
||||
If you have any questions or want to contribute, you are welcome to communicate most things via GitHub issues or pull requests.
|
||||
|
||||
Mailing List: todo
|
||||
Other active communication channels:
|
||||
|
||||
- Slack: [channel address](https://join.slack.com/t/kruise-workspace/shared_invite/enQtNjU5NzQ0ODcyNjYzLWMzZDI5NTM3ZjM1MGY2Mjg1NzU4ZjBjMDJmNjZmZTEwYTZkMzk4ZTAzNmY5NTczODhkZDU2NzVhM2I2MzNmODc)
|
||||
- Mailing List: todo
|
||||
- Dingtalk Group(钉钉讨论群)
|
||||
|
||||
<div align="center">
|
||||
<img src="docs/img/openkruise-dev-group.JPG" width="250" title="dingtalk">
|
||||
</div>
|
||||
|
||||
## Copyright
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,5 @@
|
|||
<svg version="1.1" width="36" height="36" viewBox="0 0 36 36" preserveAspectRatio="xMidYMid meet" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<title>bell-outline-badged</title>
|
||||
<path class="clr-i-outline--badged clr-i-outline-path-1--badged" d="M18,34.28A2.67,2.67,0,0,0,20.58,32H15.32A2.67,2.67,0,0,0,18,34.28Z"></path><path class="clr-i-outline--badged clr-i-outline-path-2--badged" d="M32.51,27.83A14.4,14.4,0,0,1,30,24.9a12.63,12.63,0,0,1-1.35-4.81V15.15a10.92,10.92,0,0,0-.16-1.79,7.44,7.44,0,0,1-2.24-.84,8.89,8.89,0,0,1,.4,2.64v4.94a14.24,14.24,0,0,0,1.65,5.85,16.17,16.17,0,0,0,2.44,3H5.13a16.17,16.17,0,0,0,2.44-3,14.24,14.24,0,0,0,1.65-5.85V15.15A8.8,8.8,0,0,1,18,6.31a8.61,8.61,0,0,1,4.76,1.44A7.49,7.49,0,0,1,22.5,6c0-.21,0-.42,0-.63a10.58,10.58,0,0,0-3.32-1V3.11a1.33,1.33,0,1,0-2.67,0V4.42A10.81,10.81,0,0,0,7.21,15.15v4.94A12.63,12.63,0,0,1,5.86,24.9a14.4,14.4,0,0,1-2.47,2.93,1,1,0,0,0-.34.75v1.36a1,1,0,0,0,1,1h27.8a1,1,0,0,0,1-1V28.58A1,1,0,0,0,32.51,27.83Z"></path><circle class="clr-i-outline--badged clr-i-outline-path-1--badged clr-i-badge" cx="30" cy="6" r="5"></circle>
|
||||
<rect x="0" y="0" width="36" height="36" fill-opacity="0"/>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.2 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 109 KiB |
Loading…
Reference in New Issue