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

Update Helm docs #3698

Merged
merged 2 commits into from
Mar 30, 2023
Merged

Update Helm docs #3698

merged 2 commits into from
Mar 30, 2023

Conversation

lucacome
Copy link
Member

@lucacome lucacome commented Mar 27, 2023

The Helm docs on the website are out of date. This PR updates the docs and adds to the release scripts to automate the process. The script will copy deployments/helm-chart/README.md to docs/content/installation/installation-with-helm.md and add the necessary tags for Hugo to work.

@github-actions github-actions bot added documentation Pull requests/issues for documentation helm_chart Pull requests that update the Helm Chart labels Mar 27, 2023
@codecov
Copy link

codecov bot commented Mar 27, 2023

Codecov Report

Merging #3698 (76e1bcb) into main (45838e9) will decrease coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #3698      +/-   ##
==========================================
- Coverage   52.35%   52.33%   -0.03%     
==========================================
  Files          59       59              
  Lines       16880    16880              
==========================================
- Hits         8838     8834       -4     
- Misses       7747     7749       +2     
- Partials      295      297       +2     

see 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@lucacome lucacome marked this pull request as ready for review March 28, 2023 01:57
@lucacome lucacome requested a review from a team as a code owner March 28, 2023 01:57
@lucacome lucacome self-assigned this Mar 28, 2023
@ciarams87
Copy link
Contributor

Looks good! Does this mean that we will only have to modify deployments/helm-chart/README.md for Helm changes going forward? In other words, this will be the source of truth and so we should not modify docs/content/installation/installation-with-helm.md manually any more?

@lucacome
Copy link
Member Author

@ciarams87 yep! deployments/helm-chart/README.md will be the source of truth and everything will be copied over to docs/content/installation/installation-with-helm.md

@lucacome lucacome requested review from a team March 28, 2023 22:42
@vepatel vepatel requested a review from ADubhlaoich March 29, 2023 09:23
Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

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

Overall looks grand - though I've noticed a huge amount of instances where NGINX Ingress Controller is listed just as "Ingress Controller", such as in the parameters table.

It's not a blocker of any kind, but updating them for the proper noun would be ideal.

Co-authored-by: Alan Dooley <[email protected]>
Signed-off-by: Luca Comellini <[email protected]>
@lucacome lucacome merged commit 88c5b61 into main Mar 30, 2023
@lucacome lucacome deleted the docs/update-helm branch March 30, 2023 01:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests/issues for documentation helm_chart Pull requests that update the Helm Chart
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants