Skip to content

feat: support syncing gwapi docs#5365

Merged
Xunzhuo merged 3 commits intoenvoyproxy:mainfrom
Xunzhuo:feat/support-sync-gwapi-docs
Mar 9, 2025
Merged

feat: support syncing gwapi docs#5365
Xunzhuo merged 3 commits intoenvoyproxy:mainfrom
Xunzhuo:feat/support-sync-gwapi-docs

Conversation

@Xunzhuo
Copy link
Copy Markdown
Member

@Xunzhuo Xunzhuo commented Feb 27, 2025

What type of PR is this?

What this PR does / why we need it:

support syncing gwapi docs when releasing docs.

Clipboard_Screenshot_1740649922

Which issue(s) this PR fixes:

Fixes #2749

Release Notes: Yes/No

@Xunzhuo Xunzhuo requested a review from a team as a code owner February 27, 2025 09:52
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.29%. Comparing base (12336d8) to head (87b8523).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5365      +/-   ##
==========================================
- Coverage   65.34%   65.29%   -0.05%     
==========================================
  Files         213      213              
  Lines       33915    33915              
==========================================
- Hits        22162    22146      -16     
- Misses      10426    10439      +13     
- Partials     1327     1330       +3     

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

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Xunzhuo Xunzhuo force-pushed the feat/support-sync-gwapi-docs branch 6 times, most recently from f40847e to 0ad35e8 Compare February 27, 2025 11:56
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

can we ignore this rule for certain folder?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Any suggestions for how to define the ignore specific folder?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@zirain
Copy link
Copy Markdown
Member

zirain commented Feb 27, 2025

I think we need to update the config for crd-ref-doc.

@Xunzhuo Xunzhuo marked this pull request as draft February 28, 2025 04:01
@Xunzhuo Xunzhuo force-pushed the feat/support-sync-gwapi-docs branch 5 times, most recently from 190ee58 to be10b83 Compare February 28, 2025 06:43
@Xunzhuo Xunzhuo marked this pull request as ready for review February 28, 2025 07:14
@Xunzhuo Xunzhuo force-pushed the feat/support-sync-gwapi-docs branch 2 times, most recently from 356c276 to 1cfdb53 Compare March 3, 2025 08:46
@arkodg
Copy link
Copy Markdown
Contributor

arkodg commented Mar 4, 2025

this is great, thanks for building this out @Xunzhuo !

@Xunzhuo Xunzhuo force-pushed the feat/support-sync-gwapi-docs branch from bbe239a to 9f03c7f Compare March 8, 2025 08:52
@Xunzhuo Xunzhuo requested a review from arkodg March 8, 2025 08:55
@Xunzhuo Xunzhuo force-pushed the feat/support-sync-gwapi-docs branch from 9f03c7f to ccfadb8 Compare March 8, 2025 08:55
Xunzhuo added 2 commits March 8, 2025 18:23
Signed-off-by: bitliu <bitliu@tencent.com>
Signed-off-by: bitliu <bitliu@tencent.com>
@Xunzhuo Xunzhuo force-pushed the feat/support-sync-gwapi-docs branch from ccfadb8 to c968dca Compare March 8, 2025 10:24
@Xunzhuo
Copy link
Copy Markdown
Member Author

Xunzhuo commented Mar 8, 2025

example: https://floralexplorer.cn/docs/api/

Copy link
Copy Markdown
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.

LGTM thanks !

@arkodg
Copy link
Copy Markdown
Contributor

arkodg commented Mar 8, 2025

@Xunzhuo not seeing v1alpha1 resources on here ( UDPRoute, TCPRoute, TLSRoute)

@Xunzhuo
Copy link
Copy Markdown
Member Author

Xunzhuo commented Mar 9, 2025

@arkodg not included in https://gateway-api.sigs.k8s.io/api-types/gateway as well, will figure out in a follow-up

@Xunzhuo Xunzhuo merged commit 8394b1e into envoyproxy:main Mar 9, 2025
21 checks passed
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.

docs: Show GatewayAPI APIs in EG docs

3 participants