Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Move guidelines into dev guide and add missing content #174

Merged
merged 1 commit into from
Nov 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/next/modules/en/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Original file line number Diff line number Diff line change
Expand Up @@ -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]
8 changes: 8 additions & 0 deletions docs/next/modules/en/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down