Don't show removed API reference docs#744
Conversation
Signed-off-by: irbekrm <irbekrm@gmail.com>
|
✔️ Deploy Preview for cert-manager-website ready! 🔨 Explore the source changes: 231b646 🔍 Inspect the deploy log: https://app.netlify.com/sites/cert-manager-website/deploys/61821feb7690bb00070b3bba 😎 Browse the preview: https://deploy-preview-744--cert-manager-website.netlify.app |
Signed-off-by: irbekrm <irbekrm@gmail.com>
50f53f5 to
231b646
Compare
|
/retest |
|
/cherry-pick release-1.6 |
|
@irbekrm: once the present PR merges, I will cherry-pick it on top of release-1.6 in a new PR and assign it to you. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
wallrj
left a comment
There was a problem hiding this comment.
I think this makes sense,
but don't think we need to cherry-pick in to the release-1.6 branch.
The current release is 1.6 and the docs for this are in master branch (until we release 1.7)
And if I use the correct preview link (there are now two!), I can see that the legacy APIs are no longer shown 👍
/lgtm
/approve
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: irbekrm, wallrj The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
@irbekrm: #744 failed to apply on top of branch "release-1.6": DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
This PR depends on #745 which needs to be merged and cherry-picked into release-1.6 branch first as else this will fail because we still refer to alpha/beta API versions from the API reference doc in a few places .
This PR adds a workaround to ensure that API reference docs generated from cert-manager release-1.6 branch do not include the documentation for the removed alpha and beta APIs.
The 'next' docs that are generated from release-1.7 branch still refers to alpha and beta APIs, but this will not need a workaround as we are going to remove those packages in cert-manager 1.7
Note: as the deploy preview does not include API reference docs, this fix can be verified by running the website locally:
./scripts/gendocs/generate./scripts/serverhttp://localhost:1313/and verify that the 'current' API reference docs do not include the alpha and beta API docsSigned-off-by: irbekrm irbekrm@gmail.com