diff --git a/.markdownlinkcheck.json b/.markdownlinkcheck.json index fa5f3f879352..78da0b7b6e15 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": "10s", "retryOn429": true, "retryCount": 5, diff --git a/docs/book/src/clusterctl/provider-contract.md b/docs/book/src/clusterctl/provider-contract.md index b95c38c655bb..9ba7313e2965 100644 --- a/docs/book/src/clusterctl/provider-contract.md +++ b/docs/book/src/clusterctl/provider-contract.md @@ -44,9 +44,9 @@ You can use a GitHub release to package your provider artifacts for other people 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. +* The components YAML, the metadata YAML and eventually the workload cluster templates are included 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 @@ -123,7 +123,7 @@ are not namespaced, like ClusterRoles/ClusterRoleBinding and CRD objects.

Warning

-If the generated component YAML does't contain a Namespace object, the user will be required to provide one to `clusterctl init` +If the generated component YAML doesn't contain a Namespace object, the user will be required to provide one to `clusterctl init` using the `--target-namespace` flag. In case there is more than one Namespace object in the components YAML, `clusterctl` will generate an error and abort diff --git a/docs/book/src/developer/guide.md b/docs/book/src/developer/guide.md index 834f521e8c14..b2c0fc3c6690 100644 --- a/docs/book/src/developer/guide.md +++ b/docs/book/src/developer/guide.md @@ -226,12 +226,29 @@ To test another iteration, you'll need to follow the steps to build, push, updat CAPI components and architecture +* [Cluster API Intro and Deep Dive - May 2022 v1beta1](https://www.youtube.com/watch?v=9H8flXm_lKk) * [Cluster API Deep Dive - Dec 2020 v1alpha3](https://youtu.be/npFO5Fixqcc) * [Cluster API Deep Dive - Sept 2020 v1alpha3](https://youtu.be/9SfuQQeeK6Q) * [Declarative Kubernetes Clusters with Cluster API - Oct 2020 v1alpha3](https://youtu.be/i6OWn2zRsZg) * [TGI Kubernetes 178: ClusterAPI - ClusterClass & Managed Topologies - Dec 2020 v1beta1](https://www.youtube.com/watch?v=U9CDND0nzRI&list=PL7bmigfV0EqQzxcNpmcdTJ9eFRPBe-iZa&index=5) -Code walkthrough +**Additional ClusterAPI KubeCon talks** -* [Cluster API CAPD Deep Dive - March 2021 v1alpha4](https://youtu.be/67kEp471MPk) -* [Cluster API API conversion code walkthrough - January 2022](https://www.youtube.com/watch?v=Mk14N4SelNk) +* [How to Migrate 700 Kubernetes Clusters to Cluster API with Zero Downtime - May 2022](https://www.youtube.com/watch?v=KzYV-fJ_wH0) +* [Build Your Own Cluster API Provider the Easy Way - May 2022](https://www.youtube.com/watch?v=HSdgmcAAXa8) + +**Code walkthroughs** + +* [CAPD Deep Dive - March 2021 v1alpha4](https://youtu.be/67kEp471MPk) +* [API conversion code walkthrough - January 2022](https://www.youtube.com/watch?v=Mk14N4SelNk) + +**Let's chat about ...** + +We are currently hosting "Let's chat about ..." sessions where we are talking about topics relevant to +contributors and users of the Cluster API project. For more details and an up-to-date list of recordings of past sessions please +see [Let's chat about ...](https://github.com/kubernetes-sigs/cluster-api/discussions/6106). + +* [Local CAPI development and debugging with Tilt (EMEA/Americas) - February 2022](https://www.youtube.com/watch?v=tEIRGmJahWs) +* [Local CAPI development and debugging with Tilt (APAC/EMEA) - February 2022](https://www.youtube.com/watch?v=CM-dotO2nSU) +* [Code structure & Makefile targets (EMEA/Americas) - February 2022](https://www.youtube.com/watch?v=_prbOnziCJw) +* [Code structure & Makefile targets (APAC/EMEA) - February 2022](https://www.youtube.com/watch?v=Y6Gws65H1tE)