feat(sidekick-helm-doc): Values in README generated by helm docs

[Lowaiz]

Signed-off-by: Lyonel Martinez [email protected]

What type of PR is this?

/kind documentation

Any specific area of the project related to this PR?

/area falcosidekick-chart

What this PR does / why we need it:

Helm docs integration based on falco chart one's

Which issue(s) this PR fixes:
None

It seems that config.kafka.partition and config.kafka.messageformat was useless, the sidekick doesn't document these params. and they don't appear in the config parser, so I deleted them

[Lowaiz]

/kind chart-release

[Issif]

Amazing, seems good to me, are you ready for an approval?

[alacuku]

Hey @Lowaiz, nice job!

Just a comment about the go template file. Having the README.md file generated using the go template file adds an extra step when we need just to update the docs. We first need to modify the content in README.gotmpl file, generate the README.md file and only then we can render and check the format of our docs. I would avoid this extra step by just generating the values table in separated file that is accessible from the README.md file. What do you think?

[Lowaiz]

As I use a lot of helm chart, I always prefer a README including values rather than an redirection. Furthermore, there is already one redirection from the root to each chart, so I really prefer to not add one for the user.

Having values in the README, force, a bit, the user to read these values, make them a bit more accessible and probably avoid the users to miss some information.
I guess this is a personal preference, but having a extra step to render the README is a better option, IMHO, than isolate the values in an extra file.

[Lowaiz]

Amazing, seems good to me, are you ready for an approval?

Ready when you are !

[Issif]

As I use a lot of helm chart, I always prefer a README including values rather than an redirection. Furthermore, there is already one redirection from the root to each chart, so I really prefer to not add one for the user.

Having values in the README, force, a bit, the user to read these values, make them a bit more accessible and probably avoid the users to miss some information. I guess this is a personal preference, but having a extra step to render the README is a better option, IMHO, than isolate the values in an extra file.

I'm adding the READMEs are imported by https://artifacthub.io/packages/helm/falcosecurity/falcosidekick, so it's a good practice to have all values there

[Issif]

amazing 👍
thank you

[poiana]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Issif, Lowaiz

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [Issif]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[poiana]

LGTM label has been added.

Git tree hash: 3ac59d5d8764ad937260e7b7bf7e316f3610bf0c