From 4c9ae3a003cf179b8363d806f06a25d9ade543e7 Mon Sep 17 00:00:00 2001 From: Carlos Salas Date: Mon, 2 Sep 2024 10:44:26 +0200 Subject: [PATCH] docs: edit README to add link to book Signed-off-by: Carlos Salas --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1c8aacf3..169aef61 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,10 @@ Cluster API Provider RKE2 is a combination of 2 provider types, a __Cluster API ------ -## Getting Started -Follow our [getting started guide](./docs/book/src/getting-started.md) to start creating RKE2 clusters with CAPI. +Please see our [book](https://rancher.github.io/cluster-api-provider-rke2/) for in-depth documentation. -## Developer Guide -Check our [developer guide](./docs/book/src/developers/development.md) for instructions on how to setup your dev environment in order to contribute to this project. +------ -## Get in contact -You can get in contact with us via the [#capbr](https://rancher-users.slack.com/archives/C046X0CDKCH) channel on the [Rancher Users Slack](https://slack.rancher.io/). +## How to contribute? +See our [contributor guide](https://rancher.github.io/cluster-api-provider-rke2/03_developer/00.html) for more details on how to get involved.