Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: extend documentation #216

Merged
merged 6 commits into from
Nov 6, 2023
Merged

docs: extend documentation #216

merged 6 commits into from
Nov 6, 2023

Conversation

ramizpolic
Copy link
Member

Overview

This PR adds/fixes helm docs and adds OpenSSF Best Practice badge to the repo readme.

Fixes #206 #18

Notes for reviewer

@ramizpolic ramizpolic requested a review from a team as a code owner October 16, 2023 18:22
@ramizpolic ramizpolic requested review from akijakya and removed request for a team October 16, 2023 18:22
@ramizpolic ramizpolic changed the title docs: extend docs docs: extend documentation Oct 16, 2023
@ramizpolic ramizpolic force-pushed the docs/bump branch 2 times, most recently from b2eaa18 to 7b4201c Compare October 16, 2023 18:37
akijakya
akijakya previously approved these changes Oct 17, 2023
Copy link
Member

@akijakya akijakya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nicely done, thanks!

akijakya
akijakya previously approved these changes Oct 17, 2023
@ramizpolic ramizpolic self-assigned this Oct 18, 2023
@ramizpolic ramizpolic marked this pull request as draft October 18, 2023 09:19
@ramizpolic ramizpolic marked this pull request as ready for review October 18, 2023 09:19
@ramizpolic ramizpolic requested a review from akijakya October 18, 2023 19:12
Copy link
Member

@akijakya akijakya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some comments about obsolete stuff that can be fixed in a next step, otherwise LGTM, thanks!

deploy/charts/vault-secrets-webhook/README.md.gotmpl Outdated Show resolved Hide resolved
deploy/charts/vault-secrets-webhook/README.md.gotmpl Outdated Show resolved Hide resolved
@akijakya
Copy link
Member

I just noticed a thing: there is a kubeVersion badge defined the gotmpl file, but since this field is missing from the Chart.yaml, it won't be added to the Readme (it looks for kubeVersion in the Chart.yaml instead of values.yaml).

Another thing is that updating the chart readme could be added to the pre-commit hooks, so it would refresh automatically when a something is changed around the chart, what do you think?

Copy link
Member

@akijakya akijakya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I fiddled with it, I found some issues I previously overlooked...

deploy/charts/vault-secrets-webhook/values.yaml Outdated Show resolved Hide resolved
deploy/charts/vault-secrets-webhook/README.md.gotmpl Outdated Show resolved Hide resolved
deploy/charts/vault-secrets-webhook/README.md.gotmpl Outdated Show resolved Hide resolved
@ramizpolic ramizpolic linked an issue Oct 26, 2023 that may be closed by this pull request
Signed-off-by: Ramiz Polić <ramiz.polic@hotmail.com>
Signed-off-by: Ramiz Polić <ramiz.polic@hotmail.com>
Signed-off-by: Ramiz Polić <ramiz.polic@hotmail.com>
Signed-off-by: Ramiz Polic <ramiz.polic@hotmail.com>
Signed-off-by: Ramiz Polić <ramiz.polic@hotmail.com>
Signed-off-by: Ramiz Polic <ramiz.polic@hotmail.com>
Signed-off-by: Ramiz Polić <ramiz.polic@hotmail.com>
Signed-off-by: Ramiz Polić <ramiz.polic@hotmail.com>
Copy link
Member

@akijakya akijakya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@ramizpolic ramizpolic merged commit cbff509 into main Nov 6, 2023
20 checks passed
@ramizpolic ramizpolic deleted the docs/bump branch November 6, 2023 13:44
tanmay-pnaik pushed a commit to tanmay-pnaik/vault-secrets-webhook that referenced this pull request Nov 24, 2023
* docs: add helm chart docs

Signed-off-by: Ramiz Polić <ramiz.polic@hotmail.com>

* docs: add OpenSSF Best Practices badge

Signed-off-by: Ramiz Polić <ramiz.polic@hotmail.com>

* docs: update helm chart readme

Signed-off-by: Ramiz Polić <ramiz.polic@hotmail.com>

* feat: update helm docs

Signed-off-by: Ramiz Polic <ramiz.polic@hotmail.com>
Signed-off-by: Ramiz Polić <ramiz.polic@hotmail.com>

* fix: helm installation guide

Signed-off-by: Ramiz Polic <ramiz.polic@hotmail.com>
Signed-off-by: Ramiz Polić <ramiz.polic@hotmail.com>

* docs: fix helm readme template

Signed-off-by: Ramiz Polić <ramiz.polic@hotmail.com>

---------

Signed-off-by: Ramiz Polić <ramiz.polic@hotmail.com>
Signed-off-by: Ramiz Polic <ramiz.polic@hotmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

OpenSSF best practices Generate README in helm chart
2 participants