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

doc: add certgen description into chart readme #3569

Merged
merged 3 commits into from
Jun 15, 2024

Conversation

ShyunnY
Copy link
Contributor

@ShyunnY ShyunnY commented Jun 8, 2024

What type of PR is this?

doc: add certgen description into chart readme

What this PR does / why we need it:

Which issue(s) this PR fixes:

ref: #3521

@ShyunnY ShyunnY requested a review from a team as a code owner June 8, 2024 06:13
Copy link

codecov bot commented Jun 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.22%. Comparing base (ab3a3d2) to head (5676546).
Report is 11 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3569      +/-   ##
==========================================
+ Coverage   68.19%   68.22%   +0.03%     
==========================================
  Files         168      168              
  Lines       20408    20560     +152     
==========================================
+ Hits        13918    14028     +110     
- Misses       5490     5520      +30     
- Partials     1000     1012      +12     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ShyunnY
Copy link
Contributor Author

ShyunnY commented Jun 8, 2024

PTAL
@zhaohuabing
@arkodg

@ShyunnY
Copy link
Contributor Author

ShyunnY commented Jun 8, 2024

ci gen-check block on #3555

Signed-off-by: ShyunnY <[email protected]>
@arkodg
Copy link
Contributor

arkodg commented Jun 13, 2024

@ShyunnY you will also need to run make helm-docs to generate the o/p

@arkodg
Copy link
Contributor

arkodg commented Jun 13, 2024

weird how it didn't fail geo-check

@ShyunnY
Copy link
Contributor Author

ShyunnY commented Jun 14, 2024

helm-docs

Does the helm-docs Target exist?
I don't seem to see it in my local main branch:

$ make helm-docs
make[1]: Entering directory '/home/shyunn/envoy-gateway'
make[1]: *** No rule to make target 'helm-docs'.  Stop.
make[1]: Leaving directory '/home/shyunn/envoy-gateway'
make: *** [Makefile:18: _run] Error 2

Signed-off-by: ShyunnY <[email protected]>
@shawnh2
Copy link
Contributor

shawnh2 commented Jun 14, 2024

it's helm-readme-gen which arko was referring to.

but it seems we cannot generate content from the comments in helm chart.

@arkodg
Copy link
Contributor

arkodg commented Jun 14, 2024

looks like # -- <some text> is the doc string format

@ShyunnY
Copy link
Contributor Author

ShyunnY commented Jun 15, 2024

looks like # -- <some text> is the doc string format

I have done that.

I checked the helm-docs tool. It seems that after we add the # -- <comment> comment, the object's fields will be folded into the Default column. I checked the corresponding documentation and it seems that there is no way to solve it. But this is not a problem, it just looks a bit strange.

Copy link
Contributor

@shawnh2 shawnh2 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!

Copy link
Contributor

@arkodg arkodg left a comment

Choose a reason for hiding this comment

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

Thanks !

@arkodg arkodg merged commit 68de2e1 into envoyproxy:main Jun 15, 2024
26 checks passed
@ShyunnY ShyunnY deleted the docs-certgen branch June 16, 2024 05:42
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.

4 participants