removed docs from .gitignore

Signed-off-by: Nuno do Carmo [email protected]
yiannistri · Nov 12, 2024 · 5f15dc8 · 5f15dc8
1 parent db61369
commit 5f15dc8
Show file tree

Hide file tree

Showing 267 changed files with 14,644 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,4 @@
 tmp/
-docs/
 node_modules/
 build/
 .vscode/

diff --git a/docs/next/antora.yml b/docs/next/antora.yml
@@ -0,0 +1,10 @@
+name: turtles
+title: Rancher Turtles
+version: next
+display_version: 'Next'
+start_page: en:index.adoc
+asciidoc:
+  attributes:
+    product_name: Rancher Turtles
+nav:
+  - modules/en/nav.adoc
diff --git a/docs/next/modules/en/images/30000ft_view.png b/docs/next/modules/en/images/30000ft_view.png
diff --git a/docs/next/modules/en/images/capi_logo.svg b/docs/next/modules/en/images/capi_logo.svg
diff --git a/docs/next/modules/en/images/deployments-turtles.png b/docs/next/modules/en/images/deployments-turtles.png
diff --git a/docs/next/modules/en/images/favicon.ico b/docs/next/modules/en/images/favicon.ico
diff --git a/docs/next/modules/en/images/gh_clone.png b/docs/next/modules/en/images/gh_clone.png
diff --git a/docs/next/modules/en/images/image.png b/docs/next/modules/en/images/image.png
diff --git a/docs/next/modules/en/images/image1554.png b/docs/next/modules/en/images/image1554.png
diff --git a/docs/next/modules/en/images/in_cluster_topology.png b/docs/next/modules/en/images/in_cluster_topology.png
diff --git a/docs/next/modules/en/images/install-turtles-from-ui.gif b/docs/next/modules/en/images/install-turtles-from-ui.gif
diff --git a/docs/next/modules/en/images/intro.png b/docs/next/modules/en/images/intro.png
diff --git a/docs/next/modules/en/images/logo.svg b/docs/next/modules/en/images/logo.svg
diff --git a/docs/next/modules/en/images/ns.png b/docs/next/modules/en/images/ns.png
diff --git a/docs/next/modules/en/images/rancher-logo-cow-blue.svg b/docs/next/modules/en/images/rancher-logo-cow-blue.svg
diff --git a/docs/next/modules/en/images/sidebar.png b/docs/next/modules/en/images/sidebar.png
diff --git a/docs/next/modules/en/nav.adoc b/docs/next/modules/en/nav.adoc
@@ -0,0 +1,53 @@
+* Getting Started
+** xref:index.adoc[Introduction]
+** xref:getting-started/rancher.adoc[Rancher Setup]
+** Install {product_name}
+*** xref:getting-started/install-rancher-turtles/using_rancher_dashboard.adoc[Via Rancher Dashboard]
+*** xref:getting-started/install-rancher-turtles/using_helm.adoc[Via Helm Install]
+** Your first cluster
+*** xref:getting-started/create-first-cluster/intro.adoc[Introduction]
+*** xref:getting-started/create-first-cluster/using_fleet.adoc[Create & import your first cluster using Fleet]
+*** xref:getting-started/create-first-cluster/using_kubectl.adoc[Create & Import Your First Cluster Using kubectl]
+** Using ClusterClass
+*** xref:getting-started/cluster-class/intro.adoc[Introduction]
+*** xref:getting-started/cluster-class/create_cluster.adoc[Create a cluster using Fleet]
+** xref:getting-started/air-gapped-environment.adoc[Air-gapped environment]
+** xref:getting-started/uninstall_turtles.adoc[Uninstall {product_name}]
+* Reference Guides
+** Architecture
+*** xref:reference-guides/architecture/intro.adoc[Introduction]
+*** xref:reference-guides/architecture/components.adoc[Components]
+*** xref:reference-guides/architecture/deployment.adoc[Deployment Scenarios]
+** xref:reference-guides/rancher-turtles-chart/values.adoc[Chart configuration]
+** CAPI Providers
+*** xref:reference-guides/providers/certified.adoc[Certified CAPI Providers]
+*** xref:reference-guides/providers/howto.adoc[Create & import a cluster using CAPI providers]
+*** xref:reference-guides/providers/addon-provider-fleet.adoc[Cluster API Addon Provider Fleet]
+** Test suite
+*** xref:reference-guides/test-suite/intro.adoc[Introduction]
+*** xref:reference-guides/test-suite/usage.adoc[Test suite guide]
+* Tasks
+** xref:tasks/intro.adoc[Introduction]
+** Cluster API Operator
+*** xref:tasks/capi-operator/basic_cluster_api_provider_installation.adoc[Basic Cluster API Provider Installation]
+*** xref:tasks/capi-operator/installing_core_provider.adoc[Installing the CoreProvider using CAPIProvider resource]
+*** xref:tasks/capi-operator/capiprovider_resource.adoc[CAPIProvider Resource]
+*** xref:tasks/capi-operator/clusterctlconfig_resource.adoc[ClusterctlConfig Resource]
+*** xref:tasks/capi-operator/add_infrastructure_provider.adoc[Installing AWS Infrastructure Provider using CAPIProvider resource]
+** Maintenance
+*** xref:tasks/maintenance/early_adopter_upgrade.adoc[Upgrade Instructions for Early Adopters]
+*** xref:tasks/maintenance/import_controller_upgrade.adoc[Upgrade Turtles import controller]
+*** xref:tasks/maintenance/automigrate_to_v3_import.adoc[Auto-migration to v3 cluster import]
+** Provider Certification
+*** xref:tasks/provider-certification/intro.adoc[What is a Certified Provider?]
+*** xref:tasks/provider-certification/process.adoc[Provider Certification Guide]
+* Developer Guide
+** xref:developer-guide/intro.adoc[Introduction]
+** xref:developer-guide/install_capi_operator.adoc[Installing Cluster API Operator]
+** xref:developer-guide/development.adoc[Development setup]
+* Reference
+** xref:reference/intro.adoc[Introduction]
+** xref:reference/contributing_guidelines.adoc[Guidelines]
+** xref:reference/glossary.adoc[Glossary]
+* Security
+** xref:security/slsa.adoc[SLSA]
diff --git a/docs/next/modules/en/pages/developer-guide/development.adoc b/docs/next/modules/en/pages/developer-guide/development.adoc
@@ -0,0 +1,57 @@
+= Development setup
+:sidebar_position: 3
+
+== Prerequisites:
+
+* https://kind.sigs.k8s.io/[kind]
+* https://helm.sh/[helm]
+* https://tilt.dev/[tilt]
+
+== Create a local development environment
+
+. Clone the https://github.com/rancher/turtles[{product_name}] repository locally
+. Create *tilt-settings.yaml*:
++
+[source,yaml]
+----
+{
+    "k8s_context": "k3d-rancher-test",
+    "default_registry": "ghcr.io/turtles-dev",
+    "debug": {
+        "turtles": {
+            "continue": true,
+            "port": 40000
+        }
+    }
+}
+----
++
+. Open a terminal in the root of the {product_name} repository
+. Run the following:
++
+[source,bash]
+----
+make dev-env
+
+# Or if you want to use a custom hostname for Rancher
+RANCHER_HOSTNAME=my.customhost.dev make dev-env
+----
++
+. When tilt has started, open a new terminal and start ngrok or inlets
++
+[source,bash]
+----
+kubectl port-forward --namespace cattle-system svc/rancher 10000:443
+ngrok http https://localhost:10000
+----
+
+== What happens when you run `make dev-env`?
+
+. A https://kind.sigs.k8s.io/[kind] cluster is created with the following https://github.com/rancher/turtles/blob/main/scripts/kind-cluster-with-extramounts.yaml[configuration].
+. xref:../developer-guide/install_capi_operator.adoc[Cluster API Operator] is installed using helm, which includes:
+ ** Core Cluster API controller
+ ** Kubeadm Bootstrap and Control Plane Providers
+ ** Docker Infrastructure Provider
+ ** Cert manager
+. `Rancher manager` is installed using helm.
+. `tilt up` is run to start the development environment.