From e2f8a048c3da3dc46f89da458c7e9019dd65f632 Mon Sep 17 00:00:00 2001 From: Stefan Bueringer Date: Wed, 27 Apr 2022 16:51:17 +0200 Subject: [PATCH] book: fix link to GitHub doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Stefan Büringer buringerst@vmware.com --- .markdownlinkcheck.json | 11 ++++++++--- docs/book/src/clusterctl/provider-contract.md | 2 +- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/.markdownlinkcheck.json b/.markdownlinkcheck.json index 0d47508f3ee7..7a3abfff68bd 100644 --- a/.markdownlinkcheck.json +++ b/.markdownlinkcheck.json @@ -1,9 +1,14 @@ { - "ignorePatterns": [ - { + "ignorePatterns": [{ "pattern": "^http://localhost" + }], + "httpHeaders": [{ + "comment": "Workaround as suggested here: https://github.com/tcort/markdown-link-check/issues/201", + "urls": ["https://docs.github.com/"], + "headers": { + "Accept-Encoding": "zstd, br, gzip, deflate" } -], + }], "timeout": "5s", "retryOn429": true, "retryCount": 5, diff --git a/docs/book/src/clusterctl/provider-contract.md b/docs/book/src/clusterctl/provider-contract.md index b95c38c655bb..cd6cb1f383b6 100644 --- a/docs/book/src/clusterctl/provider-contract.md +++ b/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 about how to create a release. #### Creating a local provider repository