From a6458138e5d17ff2eda0aaf6a27c22e9acf0af34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Charles-Edouard=20Br=C3=A9t=C3=A9ch=C3=A9?= Date: Sun, 3 Dec 2023 15:46:11 +0100 Subject: [PATCH] feat: add community docs page (#579) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Charles-Edouard Brétéché --- .release-notes/main.md | 6 ++++-- website/docs/community.md | 35 ++++++++++++++++++++++++++++++++ website/docs/overrides/home.html | 3 +++ website/mkdocs.yaml | 1 + 4 files changed, 43 insertions(+), 2 deletions(-) create mode 100644 website/docs/community.md diff --git a/.release-notes/main.md b/.release-notes/main.md index 8ed8e6e4c..b8b11823f 100644 --- a/.release-notes/main.md +++ b/.release-notes/main.md @@ -8,8 +8,6 @@ Release notes for `TODO`. ## ⭐ Examples ⭐ ## ⛵ Tutorials ⛵ - -## 📚 Docs 📚 --> ## ‼️ Breaking chages ‼️ @@ -32,6 +30,10 @@ Release notes for `TODO`. - Don't show `command` or `script` logs if there's nothing to show - Fixed `timeouts` always set when migrating kuttl tests +## 📚 Docs 📚 + +- Added community docs page + ## 🎸 Misc 🎸 - We now have a [dedicated slack channel](https://kubernetes.slack.com/archives/C067LUFL43U) \ No newline at end of file diff --git a/website/docs/community.md b/website/docs/community.md new file mode 100644 index 000000000..a8f1dc669 --- /dev/null +++ b/website/docs/community.md @@ -0,0 +1,35 @@ +# Community + +Chainsaw has a growing community and we would definitely love to see you join and contribute. + +Everyone is welcome to make suggestions, report bugs, open feature requests, contribute code or docs, participate in discussions, write blogs or anything that can benefit the project. + +--- + +
+Chainsaw is built and maintained under the Kyverno umbrella but decisions are +

Community driven

+

Everyone's voice matters

+
+ +--- + +## Slack channel + +Join our slack channel [#kyverno-chainsaw](https://kubernetes.slack.com/archives/C067LUFL43U) to meet with users, contributors and maintainers. + +## RoadMap + +For detailed information on our planned features and upcoming updates, please [view our Roadmap](https://github.com/kyverno/chainsaw/blob/main/ROADMAP.md). + +## Community, Events, Discussion, Contribution, and Support + +Learn more on how to engage with the [Kyverno](https://kyverno.io) community on our [community page](https://kyverno.io/community/). + +## Contributing + +Please read the [contributing guide](https://github.com/kyverno/kyverno/blob/main/CONTRIBUTING.md) for details around: + +1. Code of Conduct +1. Code Culture +1. Details on how to contribute diff --git a/website/docs/overrides/home.html b/website/docs/overrides/home.html index 30953e026..490de18b5 100644 --- a/website/docs/overrides/home.html +++ b/website/docs/overrides/home.html @@ -118,6 +118,9 @@

Kyverno end to end testing tool !

Get started + + Join the community + diff --git a/website/mkdocs.yaml b/website/mkdocs.yaml index 83cb28139..8d4ce49be 100644 --- a/website/mkdocs.yaml +++ b/website/mkdocs.yaml @@ -8,6 +8,7 @@ nav: - gh-action.md - quick-start.md - docs.md + - community.md - Writing tests: - tests/index.md - tests/configuration.md