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.

Sign up for GitHub

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

Jump to bottom

📖 book: fix link to GitHub doc #6451

Merged
merged 1 commit into from
Apr 27, 2022
Merged

📖 book: fix link to GitHub doc #6451

merged 1 commit into from
Apr 27, 2022

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 the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Apr 27, 2022
@k8s-ci-robot k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Apr 27, 2022
@sbueringer sbueringer mentioned this pull request Apr 27, 2022
Merged
@sbueringer
Copy link
Member Author

tried to use the URL where the doc is actually hosted, but has the same issue

@sbueringer sbueringer closed this Apr 27, 2022
@sbueringer sbueringer reopened this Apr 27, 2022
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 27, 2022
@sbueringer
Copy link
Member Author

sbueringer commented Apr 27, 2022 •
edited
Loading

Found a workaround for gaurav-nelson/github-action-markdown-link-check#136 suggested here tcort/markdown-link-check#201 (comment)

@sbueringer
book: fix link to GitHub doc
e2f8a04 
Signed-off-by: Stefan Büringer [email protected]
@sbueringer
Copy link
Member Author

cc @CecileRobertMichon @cpanato you might have a similar issue in CAPZ/CAPG (if you have links to github docs)

sbueringer
sbueringer commented Apr 27, 2022
View reviewed changes
docs/book/src/clusterctl/provider-contract.md
@@ -46,7 +46,7 @@ A GitHub release can be used as a provider repository if:
* The release tag is a valid semantic version number
* The components YAML, the metadata YAML and eventually the workload cluster templates are include into the release assets.

See the [GitHub help](https://help.github.com/en/github/administering-a-repository/creating-releases) for more information
See the [GitHub docs](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) for more information
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed the link to docs because help was redirecting to docs anyway and the issue is with the doc URL.

@CecileRobertMichon
Copy link
Contributor

Thanks for the heads up, just checked CAPZ doesn't reference https://help.github.com

@sbueringer
Copy link
Member Author

sbueringer commented Apr 27, 2022 •
edited
Loading

Thanks for the heads up, just checked CAPZ doesn't reference https://help.github.com

The issue is with docs.github. In our case help just redirects to docs. I think you might have it too: https://github.com/kubernetes-sigs/cluster-api-provider-azure/runs/6185196802?check_suite_focus=true

@chrischdi
Copy link
Member

/lgtm

👍

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 27, 2022
vincepri
vincepri approved these changes Apr 27, 2022
View reviewed changes
Copy link
Member

@vincepri vincepri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vincepri

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 the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 27, 2022
@k8s-ci-robot k8s-ci-robot merged commit 06a426f into kubernetes-sigs:main Apr 27, 2022
@k8s-ci-robot k8s-ci-robot added this to the v1.2 milestone Apr 27, 2022
@sbueringer sbueringer deleted the pr-fix-md-link branch April 27, 2022 17:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vincepri vincepri vincepri approved these changes

@killianmuldoon killianmuldoon Awaiting requested review from killianmuldoon

@stmcginnis stmcginnis Awaiting requested review from stmcginnis

Assignees

@chrischdi chrischdi

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
Milestone
v1.2
Development

Successfully merging this pull request may close these issues.
5 participants
@sbueringer @CecileRobertMichon @chrischdi @k8s-ci-robot @vincepri