gen-api-reference-docs: fixes for eventing-contrib #1552
Conversation
knative-prow-robot
added
the
size/M
This updates to a recent version of gen-crd-api-reference-docs and allows customizing the -api-dir option so that the docs for theeventing-contrib repo can be generated. Signed-off-by: Ahmet Alp Balkan <[email protected]>
|
/assign @RichieEscarez |
|
The build ran perfectly! Im now trying to stage and test the output in my folk. |
|
SGTM. There are some issues like duplicated API Groups (both for eventing and serving) at the beginning of the doc. It's happening because now there are different Go packages adding types to an |
|
I found something interesting (not sure if its a Golang thing), but the HTML output is incorrectly picking up a parenthesis from comment: The 404 is caused by a closing parenthesis QUESTION: Would whitespace between the URL and closing parenthesis fix this? |
|
Ill manually remove the duplicate packages and fix the URLs for now. Thanks Ahmet!
|
|
Re: duplicate Packages in serving: I found that its due to v1alpha1 vs v1beta1 (thus two |
|
Capturing manual updates: eventing-contrib-resources.md: Remove duplicate Packages links and titles + consolidate Resource Types into single list serving.md: Qualify v1alpha1 vs v1beta1 (fix Packages list, link IDs, and Section titles) |
|
We might be able to fix the parenthesis issue by tuning the Markdown renderer. Can you open an issue to the tool? |
|
[APPROVALNOTIFIER] This PR is APPROVED Approval requirements bypassed by manually added approval. This pull-request has been approved by: ahmetb The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
created #1559 for tracking the current issues |
This updates to a recent version of gen-crd-api-reference-docs and allows
customizing the -api-dir option so that the docs for theeventing-contrib repo
can be generated.
Fixes #1528.