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.

Sign up for GitHub

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

Jump to bottom

docs: support notImplementedHide #2849

Merged
merged 6 commits into from
Apr 12, 2024
Merged

docs: support notImplementedHide #2849

merged 6 commits into from
Apr 12, 2024

Conversation

zirain
Copy link
Member

@zirain zirain commented Mar 9, 2024 •
edited
Loading

Fixes: #2575

@zirain zirain requested a review from a team as a code owner March 9, 2024 16:08
@codecov Codecov
Copy link

codecov bot commented Mar 9, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.90%. Comparing base (29946b0) to head (0c4dcb0).
Report is 36 commits behind head on main.

❗ Current head 0c4dcb0 differs from pull request most recent head 0c67b69. Consider uploading reports for the commit 0c67b69 to get more accurate results

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #2849      +/-   ##
==========================================
- Coverage   66.51%   64.90%   -1.61%     
==========================================
  Files         161      121      -40     
  Lines       22673    21393    -1280     
==========================================
- Hits        15080    13886    -1194     
+ Misses       6720     6639      -81     
+ Partials      873      868       -5

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

@arkodg
Copy link
Contributor

arkodg commented Mar 9, 2024

thanks for implementing this @zirain !
ptal @envoyproxy/gateway-maintainers , we need to make a decision here on, should we fork elastic/crd-ref-docs to implement this feature or temporarily circumvent this by just adding a doc string that says unimplemented

@arkodg arkodg added the kind/decision A record of a decision made by the community. label Mar 9, 2024
@zirain
Copy link
Member Author

zirain commented Mar 13, 2024

xref: elastic/crd-ref-docs#70

@Xunzhuo
Copy link
Member

Xunzhuo commented Mar 13, 2024

Can we push this into upstream before landing it ?

@zirain
Copy link
Member Author

zirain commented Mar 30, 2024

wait for elastic/crd-ref-docs#76

arkodg
arkodg reviewed Apr 1, 2024
View reviewed changes
api/v1alpha1/backendtrafficpolicy_types.go Outdated
@@ -95,6 +95,7 @@ type BackendTrafficPolicySpec struct {
// The compression config for the http streams.
//
// +optional
// +hidefromdoc
Copy link
Contributor

Choose a reason for hiding this comment

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

like the UX !

zirain
zirain commented Apr 8, 2024
View reviewed changes
tools/src/crd-ref-docs/go.mod Outdated
@@ -2,7 +2,7 @@ module local

go 1.22

require github.com/elastic/crd-ref-docs v0.0.11
require github.com/elastic/crd-ref-docs v0.0.13-0.20240408125515-284491a93a22
Copy link
Member Author

Choose a reason for hiding this comment

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

update to latest

@zirain zirain requested a review from arkodg April 8, 2024 13:13
@arkodg
Copy link
Contributor

arkodg commented Apr 8, 2024

🎉 thanks for driving this ! and making upstream changes as well !
some nits on naming, should we call this

  • hidefromdoc
  • hidefromdocs
  • hidden
  • not-implemented

cc @envoyproxy/gateway-maintainers

@Xunzhuo
Copy link
Member

Xunzhuo commented Apr 9, 2024 •
edited
Loading

Prefer unimplemented or not-implemented

@zhaohuabing
Copy link
Member

zhaohuabing commented Apr 11, 2024 •
edited
Loading

Envoy uses a not-implemented-hide annotation in proto APIs for unimplemented features. How about using the same in EG?

@zirain
Copy link
Member Author

zirain commented Apr 11, 2024

Envoy uses a not-implemented-hide annotation in proto APIs for unimplemented features. How about using the same in EG?

I'm OK with this, it's clear enough to anyone who read it.

@Alice-Lilith
Copy link
Member

not-implemented-hide

Plus one for this

@guydc
Copy link
Contributor

guydc commented Apr 11, 2024

not-implemented-hide

Also plus one for this

@arkodg
Copy link
Contributor

arkodg commented Apr 11, 2024

the not-implemented-hides have it !

zirain added 3 commits April 12, 2024 08:03
@zirain
Copy link
Member Author

zirain commented Apr 12, 2024

not-implemented-hide

cannot use -, rename to notimplementedhide

@zirain zirain changed the title docs: support hidefromdoc docs: support notimplementedhide Apr 12, 2024
@zirain
case sensitive
b4a77e3 
Signed-off-by: zirain <[email protected]>
@zirain
Copy link
Member Author

zirain commented Apr 12, 2024

/retest

@arkodg
Copy link
Contributor

arkodg commented Apr 12, 2024

notimplementedhide is really hard to read imo

@zirain
Copy link
Member Author

zirain commented Apr 12, 2024

notimplementedhide is really hard to read imo

NotImplementedHide is better, it's case-sensitive.

@zirain zirain changed the title docs: support notimplementedhide docs: support NotImplementedHide Apr 12, 2024
@arkodg
Copy link
Contributor

arkodg commented Apr 12, 2024 •
edited
Loading

thoughts on camelCase ? notImplementedHide ?

@zirain
Copy link
Member Author

zirain commented Apr 12, 2024

thoughts on camelCase ? notImplementedHide ?

sg

@arkodg arkodg changed the title docs: support NotImplementedHide docs: support notImplementedHide Apr 12, 2024
arkodg
arkodg approved these changes Apr 12, 2024
View reviewed changes
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.

🚀

@arkodg arkodg requested review from a team April 12, 2024 04:53
@arkodg arkodg added documentation Improvements or additions to documentation and removed kind/decision A record of a decision made by the community. labels Apr 12, 2024
@zirain
Copy link
Member Author

zirain commented Apr 12, 2024

/retest

@zhaohuabing zhaohuabing merged commit d383ba5 into envoyproxy:main Apr 12, 2024
20 checks passed
@zirain zirain deleted the hidefromdoc branch April 12, 2024 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@arkodg arkodg arkodg approved these changes

@zhaohuabing zhaohuabing zhaohuabing approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Hide unimplemented API fields in docs
6 participants
@zirain @arkodg @Xunzhuo @zhaohuabing @Alice-Lilith @guydc