From e6e5e7710a0bcd646a332a03273268c24f2cb5f7 Mon Sep 17 00:00:00 2001 From: Sven Batista Steinbach Date: Wed, 26 Jun 2024 11:40:16 +0200 Subject: [PATCH] :seedling: replacing docs url (#1364) --- CONTRIBUTING.md | 4 ++-- README.md | 18 +++++++++--------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2969aa6d7..370949183 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ Help and contributions are very welcome in the form of code contributions but al 1. If working on an issue, signal other contributors that you are actively working on it by commenting on it. Wait for approval in form of someone assigning you to the issue. 2. Fork the desired repo, develop and test your code changes. - 1. See the [Development Guide](/docs/caph/04-developers/01-development-guide.md) for more instructions on setting up your environment and testing changes locally. + 1. See the [Development Guide](https://syself.com/docs/caph/developers/development-guide) for more instructions on setting up your environment and testing changes locally. 3. Submit a pull request. 1. All code PR must be created in "draft mode". This helps other contributors by not blocking E2E tests, which cannot run in parallel. After your PR is approved, you can mark it "ready for review". 1. All code PR must be have a title starting with one of @@ -41,4 +41,4 @@ Help and contributions are very welcome in the form of code contributions but al All changes must be code reviewed. Coding conventions and standards are explained in the official [developer docs](https://github.com/kubernetes/community/tree/master/contributors/devel). Expect reviewers to request that you avoid common [go style mistakes](https://github.com/golang/go/wiki/CodeReviewComments) in your PRs. -In case you want to run our E2E tests locally, please refer to [Testing](/docs/caph/04-developers/01-development-guide.md#submitting-prs-and-testing) guide. +In case you want to run our E2E tests locally, please refer to [Testing](https://syself.com/docs/caph/developers/development-guide#submitting-prs-and-testing) guide. diff --git a/README.md b/README.md index ae785bd71..fc75b0cf6 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@
-Quickstart | -Docs | -Contribution Guide

+Quickstart | +Docs | +Contribution Guide

Cluster API Book
@@ -77,11 +77,11 @@ If you don't have a dedicated team for managing Kubernetes, you can use [Syself Ready to dive in? Here are some resources to get you started: -- [**Cluster API Provider Hetzner 15 Minute Tutorial**](/docs/caph/01-getting-started/03-quickstart.md): Set up a bootstrap cluster using Kind and deploy a Kubernetes cluster on Hetzner. -- [**Develop and test Kubernetes clusters with Tilt**](/docs/caph/04-developers/01-development-guide.md): Start using Tilt for rapid testing of various cluster flavors, like with/without a private network or bare metal. -- [**Develop and test your own node-images**](/docs/caph/02-topics/02-node-image.md): Learn how to use your own machine images for production systems. +- [**Cluster API Provider Hetzner 15 Minute Tutorial**](https://syself.com/docs/caph/getting-started/quickstart): Set up a bootstrap cluster using Kind and deploy a Kubernetes cluster on Hetzner. +- [**Develop and test Kubernetes clusters with Tilt**](https://syself.com/docs/caph/developers/development-guide): Start using Tilt for rapid testing of various cluster flavors, like with/without a private network or bare metal. +- [**Develop and test your own node-images**](https://syself.com/docs/caph/topics/node-image): Learn how to use your own machine images for production systems. -In addition to the pure creation and operation of Kubernetes clusters, this provider can also validate and approve certificate signing requests. This increases security as the kubelets of the nodes can be operated with signed certificates, and enables the metrics-server to run securely. [Click here](/docs/caph/02-topics/03-advanced-caph.md#csr-controller) to read more about the CSR controller. +In addition to the pure creation and operation of Kubernetes clusters, this provider can also validate and approve certificate signing requests. This increases security as the kubelets of the nodes can be operated with signed certificates, and enables the metrics-server to run securely. [Click here](https://syself.com/docs/caph/topics/advanced-caph#csr-controller) to read more about the CSR controller. ## 🖇️ Compatibility with Cluster API and Kubernetes Versions @@ -129,13 +129,13 @@ Each version of Cluster API for Hetzner will attempt to support at least two Kub ## 📖 Documentation -Documentation can be found in the `/docs` directory. [Here](/docs/README.md) is an overview of our documentation. +Documentation can be found at: [https://syself.com/docs/caph](https://syself.com/docs/caph) ## 👥 Getting Involved and Contributing We, maintainers and the community, welcome any contributions to Cluster API Provider Hetzner. For suggestions, contributions, and assistance, contact the maintainers anytime. -To set up your environment, refer to the [development guide](/docs/caph/04-developers/01-development-guide.md). +To set up your environment, refer to the [development guide](https://syself.com/docs/caph/developers/development-guide). For new contributors, check out issues tagged as [`good first issue`][good_first_issue]. These are typically smaller in scope and great for getting familiar with the codebase.