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

reference: fix api grouping in reference docs #1561

Merged
merged 1 commit into from
Jul 1, 2019

Conversation

ahmetb
Copy link
Contributor

@ahmetb ahmetb commented Jun 29, 2019

This bumps the gen-crd-api-reference-docs to v0.1.5 which has two notable
fixes impacting Knative:

  1. Prevent types in same apiGroup but different apiVersion (e.g v1beta1 vs
    v1alpha1) from grouped together.
  2. De-duplicate the apiGroups list when types belonging to that api group come
    from different Go packages.

Fixes #1559.
/assign @RichieEscarez

This bumps the `gen-crd-api-reference-docs` to v0.1.5 which has two notable
fixes impacting Knative:

1. Prevent types in same apiGroup but different apiVersion (e.g v1beta1 vs
   v1alpha1) from grouped together.
2. De-duplicate the apiGroups list when types belonging to that api group come
   from different Go packages.

Fixes knative#1559.

Signed-off-by: Ahmet Alp Balkan <[email protected]>
@googlebot googlebot added the cla: yes Indicates the PR's author has signed the CLA. label Jun 29, 2019
@knative-prow-robot knative-prow-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jun 29, 2019
@samodell
Copy link
Contributor

samodell commented Jul 1, 2019

/lgtm
/approve

@knative-prow-robot knative-prow-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 1, 2019
@knative-prow-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ahmetb, samodell

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@knative-prow-robot knative-prow-robot merged commit 56586db into knative:master Jul 1, 2019
@ahmetb
Copy link
Contributor Author

ahmetb commented Jul 1, 2019

Can someone re-gen the docs with the updated script and see if you like what it generates?

@ahmetb ahmetb deleted the refdocs-grouping-fiz branch July 1, 2019 21:26
@RichieEscarez
Copy link
Contributor

Yes, ill give it a try soon and validate. Thanks @ahmetb!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Indicates the PR's author has signed the CLA. lgtm Indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

gen-api-reference-docs API docs build script limitations
5 participants