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

📖 book: Use relative links in generate CRDs doc #6030

Conversation

sbueringer
Copy link
Member

Signed-off-by: Stefan Büringer [email protected]

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

@k8s-ci-robot k8s-ci-robot added this to the v1.1 milestone Feb 1, 2022
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Feb 1, 2022
@sbueringer
Copy link
Member Author

@fabriziopandini I've opened this PR to get the discussion started on how we want to fix it.

I think we don't have to backport the whole #6018 PR as we don't want to v1.1=>v1.2 doc and we don't have to rename the old migration guides.

Instead I propose to make the links in the generate CRDs doc relative. This fix is cherry-pick'able to release-0.3 and release-0.4 as this section of the generate CRDs doc didn't change since release-0.3.

WDYT?

@fabriziopandini
Copy link
Member

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: fabriziopandini

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

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Feb 1, 2022
@k8s-ci-robot k8s-ci-robot merged commit 29d016b into kubernetes-sigs:release-1.1 Feb 1, 2022
@sbueringer sbueringer deleted the pr-fix-links-in-gen-crds branch February 1, 2022 14:52
@sbueringer
Copy link
Member Author

sbueringer commented Feb 1, 2022

/cherry-pick release-0.3

@sbueringer
Copy link
Member Author

/cherry-pick release-1.0

@k8s-infra-cherrypick-robot

@sbueringer: #6030 failed to apply on top of branch "release-0.3":

Applying: book: make links in generate CRDS relative
Using index info to reconstruct a base tree...
M	docs/book/src/developer/providers/implementers-guide/generate_crds.md
Falling back to patching base and 3-way merge...
Auto-merging docs/book/src/developer/providers/implementers-guide/generate_crds.md
CONFLICT (content): Merge conflict in docs/book/src/developer/providers/implementers-guide/generate_crds.md
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 book: make links in generate CRDS relative
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick release-0.3
/cherry-pick release-0.4

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.

@k8s-infra-cherrypick-robot

@sbueringer: new pull request created: #6034

In response to this:

/cherry-pick release-1.0

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.

@sbueringer
Copy link
Member Author

/cherry-pick release-0.4

@k8s-infra-cherrypick-robot

@sbueringer: new pull request created: #6035

In response to this:

/cherry-pick release-0.4

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants