Add hack script to generare reference docs for the Antrea API #1507
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for your PR. The following commands are available:
|
jianjuns
previously approved these changes
Nov 10, 2020
| # limitations under the License. | ||
|
|
||
| # This script is used to generate the reference docs for the Antrea API, which | ||
| # is included in the Antrea website. |
abhiraut
previously approved these changes
Nov 10, 2020
| {{ safe (renderComments .CommentLines) }} | ||
|
|
||
| {{ if and (eq (.Type.Name.Name) "ObjectMeta") }} | ||
| Refer to the Kubernetes API documentation for the fields of the |
There was a problem hiding this comment.
this text looks like something that is K8s API doc related.. im not sure how and where this is used though
There was a problem hiding this comment.
sorry for the delay, what's your question?
I didn't write this file, I copied it from https://github.com/ahmetb/gen-crd-api-reference-docs as it seems to be how it's meant to be used. My understanding is that this specific part generates a generic description for the ObjectMeta fields in API resources. See https://antrea.io/docs/master/api-reference/.
Generated documentation is then included on the Antrea website. The script relies on a slightly modified version of https://github.com/ahmetb/gen-crd-api-reference-docs. It doesn't require running an actual apiserver, instead it uses the Go source files directly.
antoninbas
force-pushed
the
add-script-to-generate-api-reference-docs
branch
from
1b9275a
to
50d6ad7
Compare
Codecov Report
@@ Coverage Diff @@
## master #1507 +/- ##
==========================================
- Coverage 63.31% 62.03% -1.29%
==========================================
Files 170 181 +11
Lines 14250 15300 +1050
==========================================
+ Hits 9023 9492 +469
- Misses 4292 4790 +498
- Partials 935 1018 +83
Flags with carried forward coverage won't be shown. Click here to find out more.
|
jianjuns
approved these changes
Dec 4, 2020
abhiraut
approved these changes
Dec 4, 2020
|
/skip-all |
antoninbas
added a commit
that referenced
this pull request
Dec 23, 2020
Generated documentation is then included on the Antrea website. The script relies on a slightly modified version of https://github.com/ahmetb/gen-crd-api-reference-docs. It doesn't require running an actual apiserver, instead it uses the Go source files directly.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Generated documentation is then included on the Antrea website.
The script relies on a slightly modified version of
https://github.com/ahmetb/gen-crd-api-reference-docs. It doesn't require
running an actual apiserver, instead it uses the Go source files
directly.