From 46405a5c583dbf964319994add07048d8bc85483 Mon Sep 17 00:00:00 2001 From: yiannistri <8741709+yiannistri@users.noreply.github.com> Date: Fri, 15 Nov 2024 09:58:51 +0000 Subject: [PATCH] docs: Move guidelines into dev guide and add missing content --- docs/next/modules/en/nav.adoc | 2 +- .../contributing_guidelines.adoc | 0 .../install-rancher-turtles/using_rancher_dashboard.adoc | 2 ++ docs/next/modules/en/pages/index.adoc | 8 ++++++++ 4 files changed, 11 insertions(+), 1 deletion(-) rename docs/next/modules/en/pages/{reference => developer-guide}/contributing_guidelines.adoc (100%) diff --git a/docs/next/modules/en/nav.adoc b/docs/next/modules/en/nav.adoc index 94a91e0b..8ec1c3fc 100644 --- a/docs/next/modules/en/nav.adoc +++ b/docs/next/modules/en/nav.adoc @@ -45,9 +45,9 @@ ** xref:developer-guide/intro.adoc[Introduction] ** xref:developer-guide/install_capi_operator.adoc[Installing Cluster API Operator] ** xref:developer-guide/development.adoc[Development setup] +** xref:developer-guide/contributing_guidelines.adoc[Guidelines] * Reference ** xref:reference/intro.adoc[Introduction] -** xref:reference/contributing_guidelines.adoc[Guidelines] ** xref:reference/glossary.adoc[Glossary] * Security ** xref:security/slsa.adoc[SLSA] \ No newline at end of file diff --git a/docs/next/modules/en/pages/reference/contributing_guidelines.adoc b/docs/next/modules/en/pages/developer-guide/contributing_guidelines.adoc similarity index 100% rename from docs/next/modules/en/pages/reference/contributing_guidelines.adoc rename to docs/next/modules/en/pages/developer-guide/contributing_guidelines.adoc diff --git a/docs/next/modules/en/pages/getting-started/install-rancher-turtles/using_rancher_dashboard.adoc b/docs/next/modules/en/pages/getting-started/install-rancher-turtles/using_rancher_dashboard.adoc index 3e2cdeeb..b817ff8e 100644 --- a/docs/next/modules/en/pages/getting-started/install-rancher-turtles/using_rancher_dashboard.adoc +++ b/docs/next/modules/en/pages/getting-started/install-rancher-turtles/using_rancher_dashboard.adoc @@ -59,5 +59,7 @@ The installation may take a few minutes and, when it finishes, you will be able * `rancher-turtles-system/rancher-turtles-controller-manager` * `rancher-turtles-system/rancher-turtles-cluster-api-operator` * `capi-system/capi-controller-manager` +* `rke2-bootstrap-system/rke2-bootstrap-controller-manager` +* `rke2-control-plane-system/rke2-control-plane-controller-manager` image::deployments-turtles.png[deployments-turtles] diff --git a/docs/next/modules/en/pages/index.adoc b/docs/next/modules/en/pages/index.adoc index 9e79ea07..3af51403 100644 --- a/docs/next/modules/en/pages/index.adoc +++ b/docs/next/modules/en/pages/index.adoc @@ -65,6 +65,14 @@ xref:./reference-guides/architecture/intro.adoc[architecture], how {product_name In this section we cover additional xref:./tasks/intro.adoc[operational tasks] including basic `CAPIProvider` xref:./tasks/capi-operator/basic_cluster_api_provider_installation.adoc[installation], an xref:./tasks/capi-operator/add_infrastructure_provider.adoc[example] AWS infrastructure provider install using `CAPIProvider`, and xref:./tasks/maintenance/early_adopter_upgrade.adoc[upgrade instructions] for early adopters of {product_name}. +== Developer Guide + +This section describes xref:./developer-guide/contributing_guidelines.adoc[how to get involved] in the development of Rancher Turtles as well as xref:./developer-guide/development.adoc[how to setup a local development environment], if you wish to do so. + +== Reference + +This section has a useful xref:./reference/glossary.adoc[glossary] to help you navigate Rancher and Cluster API concepts. + == Security {product_name} meets https://slsa.dev/spec/v1.0/levels#build-l3[SLSA Level 3] requirements as an appropriate hardened build platform, with consistent build processes, and provenance distribution. This section contains more information on security-related topics: