From 67421197a6831b8232eaea29b06dbc19c3477d5b Mon Sep 17 00:00:00 2001 From: Ievgenii Shepeliuk Date: Thu, 10 Sep 2020 11:47:13 +0300 Subject: [PATCH] fix: readme for helm package --- .helmignore | 1 + README.adoc | 9 +++++---- README.md | 11 +++++++++++ 3 files changed, 17 insertions(+), 4 deletions(-) create mode 100644 README.md diff --git a/.helmignore b/.helmignore index 1e646bb..2b37879 100644 --- a/.helmignore +++ b/.helmignore @@ -29,6 +29,7 @@ venv *.adoc *.txt *.json +*.adoc skaffold.yaml node_modules diff --git a/README.adoc b/README.adoc index 36c4c7d..9f378be 100644 --- a/README.adoc +++ b/README.adoc @@ -21,11 +21,12 @@ link="https://opensource.org/licenses/MIT", window="_blank"] toc::[] CMAK operator is a set of tools packaged as Helm chart, that allows to install -and configure https://github.com/yahoo/CMAK[CMAK] (ex Kafka Manager) into Kubernetes cluster. - -https://github.com/yahoo/CMAK[CMAK] (ex. Kafka Manager) is well-known -and mature tool for monitoring and managing https://kafka.apache.org/[Apache Kafka] clusters. +and configure https://github.com/yahoo/CMAK[CMAK] +(previously Kafka Manager) into Kubernetes cluster. +https://github.com/yahoo/CMAK[CMAK] (previously Kafka Manager) +is well-known and mature tool for monitoring and managing +https://kafka.apache.org/[Apache Kafka] clusters. == Prerequisites diff --git a/README.md b/README.md new file mode 100644 index 0000000..7394cf8 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# CMAK operator + +CMAK operator is a set of tools packaged as Helm chart, +that allows to install and configure [CMAK](https://github.com/yahoo/CMAK) +(previously Kafka Manager) into Kubernetes cluster. + +[CMAK](https://github.com/yahoo/CMAK) (previously Kafka Manager) is well-known +and mature tool for monitoring and managing [Apache Kafka](https://kafka.apache.org/)clusters. + +For detailled instructions about installation and configuration +check [CMAK operator homepage](https://github.com/eshepelyuk/cmak-operator).