General CCSM README rewrite #151

Zelldon · 2022-02-03T09:13:49Z

Rewrote the ccsm helm README:

Add toc to the readme
Create for each subchart a separate configuration subsection
Each subchart gots its own table with values documented
Each subchart readme points to the right section in the parent readme
Default values have been adjusted
Some other additions and improvements

relates to #124

* Add documentation on global values in values file * Add documentation for global values in readme

Adding empty default values allows to mark the type of the variable, which is better practice

npepinpe

👍

💭 The comma usages are very German 😄
🙃 We use Elasticsearch and ElasticSearch interchangeably. Now I don't know which is right 😄

charts/ccsm-helm/README.md

charts/ccsm-helm/convertValuesDoc.sh

charts/ccsm-helm/values.yaml

Co-authored-by: Nicolas Pepin-Perreault <43373+npepinpe@users.noreply.github.com>

Zelldon · 2022-02-06T09:15:32Z

The comma usages are very German

Yeah sorry. I have always issues with that, also in german 😅 It is not my strength. If you have any hints to improve or request for changes please share :)

Thanks for the review 🙇

Zelldon added 22 commits February 3, 2022 10:11

docs: document global values

4ef76b7

* Add documentation on global values in values file * Add documentation for global values in readme

docs: add zeebe values to readme

cd45909

feat: add helper script

e84b729

build: add helmignore

7760251

docs: improve install section

4c8cb10

docs: add new subsections for configs

1856f68

docs: mark some deps as optional

2399ef5

docs: improve development section

c8bccd3

docs: add gateway values to readme

0f607b3

fix: rm whitespaces from output

1ae921d

docs: add operate values to readme

a6ffe73

refactor: add better defaults to operate values

7f3b8fd

Adding empty default values allows to mark the type of the variable, which is better practice

docs: use Operate term with a capital letter

a1953f4

docs: add Tasklist values to readme

6b94200

refactor: add better defaults to tasklist values

181d49a

Adding empty default values allows to mark the type of the variable, which is better practice

docs: add elasticsearch section

9d6c813

docs: add kibana section

498086d

docs: add prometheus section

ed46fa4

docs: remove obsolete sections

594c74f

docs: add toc

2a05859

docs: add links to camunda-cloud docs

e337142

docs: replace old sub-chart readme's

4c647d1

Zelldon requested a review from npepinpe February 3, 2022 09:13

Zelldon mentioned this pull request Feb 4, 2022

[EPIC]: Create a single helm chart #124

Closed

25 tasks

npepinpe approved these changes Feb 4, 2022

View reviewed changes

Zelldon and others added 5 commits February 5, 2022 22:39

Update charts/ccsm-helm/README.md

e455015

Co-authored-by: Nicolas Pepin-Perreault <43373+npepinpe@users.noreply.github.com>

Update charts/ccsm-helm/README.md

872a01f

Co-authored-by: Nicolas Pepin-Perreault <43373+npepinpe@users.noreply.github.com>

Update charts/ccsm-helm/README.md

0797ccf

Co-authored-by: Nicolas Pepin-Perreault <43373+npepinpe@users.noreply.github.com>

docs: use Elasticsearch everywhere

a1759c1

docs: rename gateway section

646394c

Zelldon added 2 commits February 6, 2022 10:13

docs: move the docs out

73e4e8e

docs: update cluster name comment

7a3f3df

Zelldon merged commit 4f13aae into main Feb 6, 2022

Zelldon deleted the zell-general-readme-rewrite branch February 6, 2022 12:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

General CCSM README rewrite #151

General CCSM README rewrite #151

Zelldon commented Feb 3, 2022

npepinpe left a comment

Zelldon commented Feb 6, 2022

General CCSM README rewrite #151

General CCSM README rewrite #151

Conversation

Zelldon commented Feb 3, 2022

npepinpe left a comment

Choose a reason for hiding this comment

Zelldon commented Feb 6, 2022