diff --git a/docs/v0.16/antora.yml b/docs/v0.16/antora.yml new file mode 100644 index 00000000..d9d52aca --- /dev/null +++ b/docs/v0.16/antora.yml @@ -0,0 +1,10 @@ +name: turtles +title: Rancher Turtles +version: v0.16 +display_version: 'v0.16' +start_page: en:index.adoc +asciidoc: + attributes: + product_name: Rancher Turtles +nav: + - modules/en/nav.adoc \ No newline at end of file diff --git a/docs/v0.16/modules/en/images/30000ft_view.png b/docs/v0.16/modules/en/images/30000ft_view.png new file mode 100644 index 00000000..7441fa1b Binary files /dev/null and b/docs/v0.16/modules/en/images/30000ft_view.png differ diff --git a/docs/v0.16/modules/en/images/capi_logo.svg b/docs/v0.16/modules/en/images/capi_logo.svg new file mode 100644 index 00000000..2133449f --- /dev/null +++ b/docs/v0.16/modules/en/images/capi_logo.svg @@ -0,0 +1 @@ +kubernetes-cluster-logos_final \ No newline at end of file diff --git a/docs/v0.16/modules/en/images/deployments-turtles.png b/docs/v0.16/modules/en/images/deployments-turtles.png new file mode 100644 index 00000000..c165360a Binary files /dev/null and b/docs/v0.16/modules/en/images/deployments-turtles.png differ diff --git a/docs/v0.16/modules/en/images/favicon.ico b/docs/v0.16/modules/en/images/favicon.ico new file mode 100644 index 00000000..630449c0 Binary files /dev/null and b/docs/v0.16/modules/en/images/favicon.ico differ diff --git a/docs/v0.16/modules/en/images/gh_clone.png b/docs/v0.16/modules/en/images/gh_clone.png new file mode 100644 index 00000000..1909eba2 Binary files /dev/null and b/docs/v0.16/modules/en/images/gh_clone.png differ diff --git a/docs/v0.16/modules/en/images/image.png b/docs/v0.16/modules/en/images/image.png new file mode 100644 index 00000000..2f4da268 Binary files /dev/null and b/docs/v0.16/modules/en/images/image.png differ diff --git a/docs/v0.16/modules/en/images/image1554.png b/docs/v0.16/modules/en/images/image1554.png new file mode 100644 index 00000000..0a074a55 Binary files /dev/null and b/docs/v0.16/modules/en/images/image1554.png differ diff --git a/docs/v0.16/modules/en/images/in_cluster_topology.png b/docs/v0.16/modules/en/images/in_cluster_topology.png new file mode 100644 index 00000000..7be5f6c9 Binary files /dev/null and b/docs/v0.16/modules/en/images/in_cluster_topology.png differ diff --git a/docs/v0.16/modules/en/images/install-turtles-from-ui.gif b/docs/v0.16/modules/en/images/install-turtles-from-ui.gif new file mode 100644 index 00000000..80f6880e Binary files /dev/null and b/docs/v0.16/modules/en/images/install-turtles-from-ui.gif differ diff --git a/docs/v0.16/modules/en/images/intro.png b/docs/v0.16/modules/en/images/intro.png new file mode 100644 index 00000000..49d88593 Binary files /dev/null and b/docs/v0.16/modules/en/images/intro.png differ diff --git a/docs/v0.16/modules/en/images/logo.svg b/docs/v0.16/modules/en/images/logo.svg new file mode 100644 index 00000000..e65404a5 --- /dev/null +++ b/docs/v0.16/modules/en/images/logo.svg @@ -0,0 +1,106 @@ + + + + + + + + + + + + + + diff --git a/docs/v0.16/modules/en/images/ns.png b/docs/v0.16/modules/en/images/ns.png new file mode 100644 index 00000000..b9b7ff41 Binary files /dev/null and b/docs/v0.16/modules/en/images/ns.png differ diff --git a/docs/v0.16/modules/en/images/rancher-logo-cow-blue.svg b/docs/v0.16/modules/en/images/rancher-logo-cow-blue.svg new file mode 100644 index 00000000..8353dec6 --- /dev/null +++ b/docs/v0.16/modules/en/images/rancher-logo-cow-blue.svg @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/v0.16/modules/en/images/sidebar.png b/docs/v0.16/modules/en/images/sidebar.png new file mode 100644 index 00000000..a7371d20 Binary files /dev/null and b/docs/v0.16/modules/en/images/sidebar.png differ diff --git a/docs/v0.16/modules/en/nav.adoc b/docs/v0.16/modules/en/nav.adoc new file mode 100644 index 00000000..e97daf0d --- /dev/null +++ b/docs/v0.16/modules/en/nav.adoc @@ -0,0 +1,55 @@ +* 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] +** xref:developer-guide/contributing_guidelines.adoc[Guidelines] +* Reference +** xref:reference/intro.adoc[Introduction] +** xref:reference/glossary.adoc[Glossary] +** xref:reference/features.adoc[Features] +* Security +** xref:security/slsa.adoc[SLSA] +* xref:changelogs/index.adoc[Release Notes] diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.1.0.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.1.0.adoc new file mode 100644 index 00000000..70edc4e9 --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.1.0.adoc @@ -0,0 +1,163 @@ +== "v0.1.0" +=== "2023-10-03 10:02:01 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2023-10-03 10:02:01 +0000 UTC - v0.1.0__ + + +=== Description + +--- + +++++ + +

Rancher Turtles

+ +

Cluster API coming to Rancher

+

Cluster API enables managing clusters provisioning in a declarative GitOps-friendly approach, allowing users to manage efficiently huge numbers of rancher clusters through a standardised interface. Additionally, users can leverage the upstream CAPI ecosystem and benefit from the many existing infrastructure providers that enable users to provision clusters on many infrastructure provider targets.

+

Cluster API is released as an Extension for Rancher, allowing that traditional provisioning and cluster-api can be used side by side. That makes it a great fit not just for greenfield projects, as well existing rancher manager users can benefit.

+

Ranchers Cluster API extension is initially released as part of our early adopter program, enabling close collaboration with our customers, shaping jointly a mature solution that is battle proven. We are aiming to bring early Q1 Cluster API into GA and production support. If you are interested in joining our Early Adopter Program for Cluster API , don't hesitate to reach out.

+

If you want to get your hands wet, take a look at our documentation and give it a try. If you are stuck, have question or feedback, please ping us in the Rancher Users #cluster-api slack channel.

+

What's Changed

+

🚀 Enhancements

+ +

🐛 Bugs

+ +

📖 Docs

+ +

Other Changes

+ +

New Contributors

+ +

Full Changelog: https://github.com/rancher-sandbox/rancher-turtles/commits/v0.1.0

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.1.0/rancher-turtles-0.1.0.tgz[rancher-turtles-0.1.0.tgz] | 2023-10-03 09:35:05 +0000 UTC | 2023-10-03T09:35:05Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.1.0[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.10.0.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.10.0.adoc new file mode 100644 index 00000000..502e8b3f --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.10.0.adoc @@ -0,0 +1,69 @@ +== "v0.10.0" +=== "2024-07-29 10:04:39 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2024-07-29 10:04:39 +0000 UTC - v0.10.0__ + + +=== Description + +--- + +++++ + +

Rancher Turtles is an extension to Rancher that brings full Cluster API integration to Rancher.

+ +

What's Changed

+

🚀 Enhancements

+ +

🐛 Bugs

+ +

📖 Docs

+ +

Other Changes

+ +

Full Changelog: v0.9.0...v0.10.0

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.10.0/rancher-turtles-0.10.0.tgz[rancher-turtles-0.10.0.tgz] | 2024-07-29 10:04:40 +0000 UTC | 2024-07-29T10:04:40Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.10.0[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.11.0.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.11.0.adoc new file mode 100644 index 00000000..668768d5 --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.11.0.adoc @@ -0,0 +1,89 @@ +== "v0.11.0" +=== "2024-08-22 14:23:44 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2024-08-22 14:23:44 +0000 UTC - v0.11.0__ + + +=== Description + +--- + +++++ + +

🚀 This release brings two new providers to the list of certified providers: CAPV (vSphere) from experimental to GA and CAPZ (Azure). Moreover, our test suite is now available for prospective end-users to use and add their providers to the list of certified providers. For more information please read here.

+

Rancher Turtles is an extension to Rancher that brings full Cluster API integration to Rancher.

+ +

What's Changed

+

🚀 Enhancements

+ +

🐛 Bugs

+ +

📖 Docs

+ +

🌱 Others

+ +

New Contributors

+ +

Full Changelog: v0.10.0...v0.11.0

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.11.0/rancher-turtles-0.11.0.tgz[rancher-turtles-0.11.0.tgz] | 2024-08-22 14:23:44 +0000 UTC | 2024-08-22T14:23:45Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.11.0[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.12.0.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.12.0.adoc new file mode 100644 index 00000000..4d33d84d --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.12.0.adoc @@ -0,0 +1,102 @@ +== "v0.12.0" +=== "2024-09-26 09:53:01 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2024-09-26 09:53:01 +0000 UTC - v0.12.0__ + + +=== Description + +--- + +++++ + +

Rancher Turtles is an extension to Rancher that brings full Cluster API integration to Rancher.

+

This release brings a number of new features, including:

+ +

What's Changed

+

🚀 Enhancements

+ +

🐛 Bugs

+ +

📖 Docs

+ +

Other Changes

+ +

New Contributors

+ +

Full Changelog: v0.11.0...v0.12.0

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.12.0/rancher-turtles-0.12.0.tgz[rancher-turtles-0.12.0.tgz] | 2024-09-26 09:53:02 +0000 UTC | 2024-09-26T09:53:02Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.12.0[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.13.0.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.13.0.adoc new file mode 100644 index 00000000..be9ac2fd --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.13.0.adoc @@ -0,0 +1,96 @@ +== "v0.13.0" +=== "2024-10-28 11:45:00 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2024-10-28 11:45:00 +0000 UTC - v0.13.0__ + + +=== Description + +--- + +++++ + +

Rancher Turtles is an extension to Rancher that brings full Cluster API integration to Rancher.

+

This release brings a number of bug fixes and improvements, including:

+ + +

What's Changed

+

🚀 Enhancements

+ +

🐛 Bugs

+ +

📖 Docs

+ +

Other Changes

+ +

New Contributors

+ +

Full Changelog: v0.12.0...v0.13.0

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.13.0/rancher-turtles-0.13.0.tgz[rancher-turtles-0.13.0.tgz] | 2024-10-28 11:45:01 +0000 UTC | 2024-10-28T11:45:01Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.13.0[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.14.0.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.14.0.adoc new file mode 100644 index 00000000..3c12ae75 --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.14.0.adoc @@ -0,0 +1,93 @@ +== "v0.14.0" +=== "2024-12-02 20:20:03 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2024-12-02 20:20:03 +0000 UTC - v0.14.0__ + + +=== Description + +--- + +++++ + + +

What's Changed

+

🚀 Enhancements

+ +

🐛 Bugs

+ +

Other Changes

+ +

New Contributors

+ +

Full Changelog: v0.13.0...v0.14.0

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.14.0/rancher-turtles-0.14.0.tgz[rancher-turtles-0.14.0.tgz] | 2024-12-02 20:20:03 +0000 UTC | 2024-12-02T20:20:04Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.14.0[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.14.1.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.14.1.adoc new file mode 100644 index 00000000..4c87867b --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.14.1.adoc @@ -0,0 +1,44 @@ +== "v0.14.1" +=== "2024-12-03 09:34:26 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2024-12-03 09:34:26 +0000 UTC - v0.14.1__ + + +=== Description + +--- + +++++ + + +

What's Changed

+

Other Changes

+ +

Full Changelog: v0.14.0...v0.14.1

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.14.1/rancher-turtles-0.14.1.tgz[rancher-turtles-0.14.1.tgz] | 2024-12-03 09:34:27 +0000 UTC | 2024-12-03T09:34:27Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.14.1[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.15.0.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.15.0.adoc new file mode 100644 index 00000000..36b8e3c1 --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.15.0.adoc @@ -0,0 +1,63 @@ +== "v0.15.0" +=== "2024-12-19 10:32:58 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2024-12-19 10:32:58 +0000 UTC - v0.15.0__ + + +=== Description + +--- + +++++ + + +

What's Changed

+

🐛 Bugs

+ +

Other Changes

+ +

Full Changelog: v0.14.1...v0.15.0

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.15.0/rancher-turtles-0.15.0.tgz[rancher-turtles-0.15.0.tgz] | 2024-12-19 10:32:59 +0000 UTC | 2024-12-19T10:32:59Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.15.0[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.16.0.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.16.0.adoc new file mode 100644 index 00000000..5855db7b --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.16.0.adoc @@ -0,0 +1,143 @@ +== "v0.16.0" +=== "2025-01-30 10:15:15 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2025-01-30 10:15:15 +0000 UTC - v0.16.0__ + + +=== Description + +--- + +++++ + + +

This release of Rancher Turtles focuses on:

+ +

What's Changed

+

🚀 Enhancements

+ +

🐛 Bugs

+ +

📖 Docs

+ +

Other Changes

+ +

New Contributors

+ +

Full Changelog: v0.15.0...v0.16.0

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.16.0/rancher-turtles-0.16.0.tgz[rancher-turtles-0.16.0.tgz] | 2025-01-30 10:15:16 +0000 UTC | 2025-01-30T10:15:16Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.16.0[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.2.0.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.2.0.adoc new file mode 100644 index 00000000..0ef9e972 --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.2.0.adoc @@ -0,0 +1,81 @@ +== "v0.2.0" +=== "2023-10-23 14:56:55 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2023-10-23 14:56:55 +0000 UTC - v0.2.0__ + + +=== Description + +--- + +++++ + +

Rancher Turtles

+ +

What's Changed

+

🚀 Enhancements

+ +

🐛 Bugs

+ +

📖 Docs

+ +

Other Changes

+ +

Full Changelog: v0.1.0...v0.2.0

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.2.0/rancher-turtles-0.2.0.tgz[rancher-turtles-0.2.0.tgz] | 2023-10-23 14:56:55 +0000 UTC | 2023-10-23T14:56:56Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.2.0[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.3.0.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.3.0.adoc new file mode 100644 index 00000000..1b157366 --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.3.0.adoc @@ -0,0 +1,76 @@ +== "v0.3.0" +=== "2023-11-20 12:26:12 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2023-11-20 12:26:12 +0000 UTC - v0.3.0__ + + +=== Description + +--- + +++++ + +

Rancher Turtles is a extension to Rancher that brings full Cluster API integration to Rancher.

+ +

What's Changed

+

🚀 Enhancements

+ +

🐛 Bugs

+ +

Other Changes

+ +

Full Changelog: v0.2.0...v0.3.0

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.3.0/rancher-turtles-0.3.0.tgz[rancher-turtles-0.3.0.tgz] | 2023-11-20 12:26:13 +0000 UTC | 2023-11-20T12:26:13Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.3.0[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.4.0.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.4.0.adoc new file mode 100644 index 00000000..e7956144 --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.4.0.adoc @@ -0,0 +1,97 @@ +== "v0.4.0" +=== "2024-01-09 11:39:06 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2024-01-09 11:39:06 +0000 UTC - v0.4.0__ + + +=== Description + +--- + +++++ + +

Rancher Turtles is a extension to Rancher that brings full Cluster API integration to Rancher.

+ +

What's Changed

+

🚀 Enhancements

+ +

🐛 Bugs

+ +

📖 Docs

+ +

Other Changes

+ +

New Contributors

+ +

Full Changelog: v0.3.0...v0.4.0

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.4.0/rancher-turtles-0.4.0.tgz[rancher-turtles-0.4.0.tgz] | 2024-01-09 11:39:07 +0000 UTC | 2024-01-09T11:39:07Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.4.0[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.4.1.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.4.1.adoc new file mode 100644 index 00000000..77955c63 --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.4.1.adoc @@ -0,0 +1,45 @@ +== "v0.4.1" +=== "2024-01-17 17:18:48 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2024-01-17 17:18:48 +0000 UTC - v0.4.1__ + + +=== Description + +--- + +++++ + +

Rancher Turtles is a extension to Rancher that brings full Cluster API integration to Rancher.

+ +

What's Changed

+

🐛 Bugs

+ +

Full Changelog: v0.4.0...v0.4.1

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.4.1/rancher-turtles-0.4.1.tgz[rancher-turtles-0.4.1.tgz] | 2024-01-17 17:18:49 +0000 UTC | 2024-01-17T17:18:49Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.4.1[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.5.0.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.5.0.adoc new file mode 100644 index 00000000..685ae90a --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.5.0.adoc @@ -0,0 +1,64 @@ +== "v0.5.0" +=== "2024-02-15 11:32:39 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2024-02-15 11:32:39 +0000 UTC - v0.5.0__ + + +=== Description + +--- + +++++ + +

Rancher Turtles is a extension to Rancher that brings full Cluster API integration to Rancher.

+ +

What's Changed

+

🚀 Enhancements

+ +

🐛 Bugs

+ +

📖 Docs

+ +

Other Changes

+ +

Full Changelog: v0.4.0...v0.5.0

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.5.0/rancher-turtles-0.5.0.tgz[rancher-turtles-0.5.0.tgz] | 2024-02-15 11:32:40 +0000 UTC | 2024-02-15T11:32:40Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.5.0[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.6.0.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.6.0.adoc new file mode 100644 index 00000000..32e9a000 --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.6.0.adoc @@ -0,0 +1,136 @@ +== "v0.6.0" +=== "2024-04-04 12:21:10 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2024-04-04 12:21:10 +0000 UTC - v0.6.0__ + + +=== Description + +--- + +++++ + +

Rancher Turtles (The Cluster API Extension) GA

+

We are pleased to announce that the Rancher Cluster API Extension (a.k.a Rancher Turtles) is becoming generally available, transitioning out from an early adopter program.

+

With each new release going forward we will include a table of the features that have moved to be fully supported and the new features that are experimental.

+

The initial GA is targeted at the GitOps workflow (to be used, for example, with Fleet) and cluster creation / operations will need to be performed via the CAPI cluster definitions directly (applied to the management cluster).

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SupportedExperimental (not suitable for production)
Automatic import of CAPI Clusters into RancherEverything not specifically listed on the “Supported” column
Enabling CAPI Providers (excluding integration with Rancher Cloud Credentials)CAPIProvider integration with Rancher Cloud Credentials.
Cluster provisioning via Fleet (i.e. GitOps)Cluster API Provider vSphere (non-experimental features with the exception of machine pools and clusterclass)
Cluster API Provider AWS (non-experimental features with the exception of machine pools and clusterclass)
Cluster API Provider RKE2 (excluding any day 2 operations like ETCD Backup & Restore)
+

Supported versions:

+ +

We are also developing an UI extension that will be released in the future. This is only available at present via the early adopter programme. Please get in contact with your account team about details.

+ +

What's Changed

+

🚀 Enhancements

+ +

🐛 Bugs

+ +

📖 Docs

+ +

🌱 Other Changes

+ +

Full Changelog: v0.5.0...v0.6.0

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.6.0/rancher-turtles-0.6.0.tgz[rancher-turtles-0.6.0.tgz] | 2024-04-04 12:21:11 +0000 UTC | 2024-04-04T12:21:11Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.6.0[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.7.0.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.7.0.adoc new file mode 100644 index 00000000..59d68c70 --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.7.0.adoc @@ -0,0 +1,109 @@ +== "v0.7.0" +=== "2024-05-02 14:21:37 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2024-05-02 14:21:37 +0000 UTC - v0.7.0__ + + +=== Description + +--- + +++++ + +

Rancher Turtles is an extension to Rancher that brings full Cluster API integration to Rancher.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SupportedExperimental (not suitable for production)
Automatic import of CAPI Clusters into RancherEverything not specifically listed on the “Supported” column
Enabling CAPI Providers (excluding integration with Rancher Cloud Credentials)CAPIProvider integration with Rancher Cloud Credentials.
Cluster provisioning via Fleet (i.e. GitOps)Cluster API Provider vSphere (non-experimental features with the exception of machine pools and clusterclass)
Cluster API Provider AWS (non-experimental features with the exception of machine pools and clusterclass)
Cluster API Provider RKE2 (excluding any day 2 operations like ETCD Backup & Restore)
+

Supported versions:

+ +

We are also developing an UI extension that will be released in the future. This is only available at present via the early adopter programme. Please get in contact with your account team about details.

+ + +

What's Changed

+

🚀 Enhancements

+ +

🐛 Bugs

+ +

📖 Docs

+ +

Other Changes

+ +

Full Changelog: v0.6.0...v0.7.0

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.7.0/rancher-turtles-0.7.0.tgz[rancher-turtles-0.7.0.tgz] | 2024-05-02 14:21:38 +0000 UTC | 2024-05-02T14:21:38Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.7.0[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.8.0.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.8.0.adoc new file mode 100644 index 00000000..456aa960 --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.8.0.adoc @@ -0,0 +1,66 @@ +== "v0.8.0" +=== "2024-05-30 12:11:48 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2024-05-30 12:11:48 +0000 UTC - v0.8.0__ + + +=== Description + +--- + +++++ + +

Rancher Turtles is an extension to Rancher that brings full Cluster API integration to Rancher.

+ +

What's Changed

+

🚀 Enhancements

+ +

🐛 Bugs

+ +

Other Changes

+ +

New Contributors

+ +

Full Changelog: v0.7.0...v0.8.0

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.8.0/rancher-turtles-0.8.0.tgz[rancher-turtles-0.8.0.tgz] | 2024-05-30 12:11:49 +0000 UTC | 2024-05-30T12:11:49Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.8.0[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.9.0.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.9.0.adoc new file mode 100644 index 00000000..04071aaa --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.9.0.adoc @@ -0,0 +1,108 @@ +== "v0.9.0" +=== "2024-06-28 10:54:06 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2024-06-28 10:54:06 +0000 UTC - v0.9.0__ + + +=== Description + +--- + +++++ + +

⚠️ Important:

+

Starting with Turtles v0.9.0, the process used for importing CAPI clusters into Rancher has changed. We recommend you take a look at the changelog and the instructions provided in the v0.9 version of the Turtles book: https://turtles.docs.rancher.com/

+

Rancher Turtles is an extension to Rancher that brings full Cluster API integration to Rancher.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SupportedExperimental (not suitable for production)
Automatic import of CAPI Clusters into RancherEverything not specifically listed on the “Supported” column
Manual migration from provisioning/v1 to management/v3 Cluster importCluster API Provider vSphere (non-experimental features with the exception of machine pools and clusterclass)
Automatic migration from provisioning/v1 to management/v3 Cluster import (disabled by default)CAPIProvider integration with Rancher Cloud Credentials.
Enabling CAPI Providers (excluding integration with Rancher Cloud Credentials)
Cluster provisioning via Fleet (i.e. GitOps)
Cluster API Provider AWS (non-experimental features with the exception of machine pools and clusterclass)
Cluster API Provider RKE2 (excluding any day 2 operations like ETCD Backup & Restore)
+

Supported versions:

+ +

What's Changed

+

🚀 Enhancements

+ +

📖 Docs

+ +

Other Changes

+ +

Full Changelog: v0.8.0...v0.9.0

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.9.0/rancher-turtles-0.9.0.tgz[rancher-turtles-0.9.0.tgz] | 2024-06-28 10:54:07 +0000 UTC | 2024-06-28T10:54:07Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.9.0[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.9.1.adoc b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.9.1.adoc new file mode 100644 index 00000000..4f7ce67b --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/changelogs/v0.9.1.adoc @@ -0,0 +1,48 @@ +== "v0.9.1" +=== "2024-07-18 13:15:25 +0000 UTC" + +// Disclaimer: this file is generated, do not edit it manually. + + +__ (github-actions[bot]) released this 2024-07-18 13:15:25 +0000 UTC - v0.9.1__ + + +=== Description + +--- + +++++ + +

Rancher Turtles is an extension to Rancher that brings full Cluster API integration to Rancher.

+ +

What's Changed

+

🐛 Bugs

+ +

These fixes are cherry-picked for patch release here

+

Full Changelog: v0.9.0...v0.9.1

+ +++++ + +--- + + + +=== Download + +[cols="3,1,1" options="header" frame="all" grid="rows"] +|=== +| Name | Created At | Updated At + +| link:https://github.com/rancher/turtles/releases/download/v0.9.1/rancher-turtles-0.9.1.tgz[rancher-turtles-0.9.1.tgz] | 2024-07-18 13:15:26 +0000 UTC | 2024-07-18T13:15:26Z + +|=== + + +--- + +__Information retrieved from link:https://github.com/rancher/turtles/releases/tag/v0.9.1[here]__ + diff --git a/docs/v0.16/modules/en/pages/changelogs/index.adoc b/docs/v0.16/modules/en/pages/changelogs/index.adoc new file mode 100644 index 00000000..896c7b3a --- /dev/null +++ b/docs/v0.16/modules/en/pages/changelogs/index.adoc @@ -0,0 +1,41 @@ += Release Notes + + +* link:changelogs/v0.16.0.html[v0.16.0 (latest)] + +* link:changelogs/v0.15.0.html[v0.15.0 ] + +* link:changelogs/v0.14.1.html[v0.14.1 ] + +* link:changelogs/v0.14.0.html[v0.14.0 ] + +* link:changelogs/v0.13.0.html[v0.13.0 ] + +* link:changelogs/v0.12.0.html[v0.12.0 ] + +* link:changelogs/v0.11.0.html[v0.11.0 ] + +* link:changelogs/v0.10.0.html[v0.10.0 ] + +* link:changelogs/v0.9.1.html[v0.9.1 ] + +* link:changelogs/v0.9.0.html[v0.9.0 ] + +* link:changelogs/v0.8.0.html[v0.8.0 ] + +* link:changelogs/v0.7.0.html[v0.7.0 ] + +* link:changelogs/v0.6.0.html[v0.6.0 ] + +* link:changelogs/v0.5.0.html[v0.5.0 ] + +* link:changelogs/v0.4.1.html[v0.4.1 ] + +* link:changelogs/v0.4.0.html[v0.4.0 ] + +* link:changelogs/v0.3.0.html[v0.3.0 ] + +* link:changelogs/v0.2.0.html[v0.2.0 ] + +* link:changelogs/v0.1.0.html[v0.1.0 ] + diff --git a/docs/v0.16/modules/en/pages/developer-guide/contributing_guidelines.adoc b/docs/v0.16/modules/en/pages/developer-guide/contributing_guidelines.adoc new file mode 100644 index 00000000..7c432aa8 --- /dev/null +++ b/docs/v0.16/modules/en/pages/developer-guide/contributing_guidelines.adoc @@ -0,0 +1,279 @@ += Guidelines + +// START doctoc generated TOC please keep comment here to allow auto update + +// DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE + +* <<_how_to_get_involved,How to get involved?>> +* <<_submitting_prs,Submitting PRs>> + ** <<_choosing_something_to_work_on,Choosing something to work on>> + ** <<_developing_rancher_turtles,Developing rancher-turtles>> + ** <<_asking_for_help,Asking for help>> + ** <<_pr_submission_guidelines,PR submission guidelines>> + *** <<_commit_message_formatting,Commit message formatting>> +* <<_opening_issues,Opening Issues>> +* <<_how_the_maintainers_process_contributions,How the Maintainers process contributions>> + ** <<_prioritizing_issues,Prioritizing issues>> + ** <<_reviewing_prs,Reviewing PRs>> +* <<_adrs_architectural_decision_records,ADRs (Architectural Decision Records)>> + ** <<_process,Process>> + +// END doctoc generated TOC please keep comment here to allow auto update + +Thank you for taking the time to contribute to Rancher CAPI extension https://github.com/rancher?q=turtles&type=all&language=&sort=[projects]. + +Improvements to all areas of the project; from code, to documentation; +from bug reports to feature design and UI enhancement are gratefully welcome. +This guide should cover all aspects of how to interact with the project +and how to get involved in development as smoothly as possible. + +Reading docs is often tedious, so let's put the important contributing rule +right at the top: *Always be kind!* + +Looking forward to seeing your contributions in the repo! + +== How to get involved? + +We'd love to accept your patches in pretty much all areas of projects development! + +If you're a new to the project and want to help, but don't know where to start, here is a non-exhaustive list of ways you can help out: + +. Submit a <<_submitting_prs,Pull Request>> ++ +Beyond fixing bugs and submitting new features, there are other things you can submit + which, while less flashy, will be deeply appreciated by all who interact with the codebase: + + ** Extending test coverage! + ** Refactoring! + ** Reviewing and updating https://rancher.github.io/turtles-docs/[documentation]! + ** Adding a new UI functionality! + ++ +(See also <<_choosing_something_to_work_on,Choosing something to work on>> below.) + +. Open an <<_opening_issues,issue>> ++ +We have 2 forms of issues: bug reports and feature requests. If you are not sure which category you need, just make the best guess and provide as much information as possible. + +. Interested in helping to improve: + +* Rancher CAPI extension backend? Chime in on https://github.com/rancher/turtles/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fbug+[`bugs`] or + https://github.com/rancher/turtles/labels/help-wanted[`help wanted` issues]. + If you are seeking to take on a bigger challenge or a more experienced contributor, check out https://github.com/rancher/turtles/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Ffeature[`feature requests`]. +* extension UI? Take a look at https://github.com/rancher/capi-ui-extension[`open`] or + https://github.com/rancher/capi-ui-extension/labels/help-wanted[`help wanted` issues]. +* maybe, user-docs? Then, jump straight into https://github.com/rancher/turtles-docs/issues[`open` issues] in the docs repository. + +== Opening Issues + +These guides aim to help you write issues in a way which will ensure that they are processed +as quickly as possible. + +_See below for <<_prioritizing_issues,how issues are prioritized>>_. + +*General rules*: + +. Before opening anything, take a good look through existing issues. +. More is more: give as much information as it is humanly possible to give. + Highly detailed issues are more likely to be picked up because they can be prioritized and + scheduled for work faster. They are also more accessible + to the community, meaning that you may not have to wait for the core team to get to it. +. Please do not open an issue with a description that is *just* a link to another issue, + a link to a slack conversation, a quote from either one of those, or anything else + equally opaque. This raises the bar for entry and makes it hard for the community + to get involved. Take the time to write a proper description and summarise key points. +. Take care with formatting. Ensure the https://docs.github.com/en/free-pro-team@latest/github/writing-on-github/getting-started-with-writing-and-formatting-on-github[markdown is tidy], + use https://docs.github.com/en/free-pro-team@latest/github/writing-on-github/creating-and-highlighting-code-blocks[code blocks] etc etc. + The faster something can be read, the faster it can be dealt with. +. Keep it civil. Yes, it is annoying when things don't work, but it is way more fun helping out + someone who is not... the worst. Remember that conversing via text exacerbates + everyone's negativity bias, so throw in some emoji when in doubt. + +== Submitting PRs + +=== Choosing something to work on + +If you are here to ask for help or request some new behaviour, this +is the section for you. We have curated a set of issues for anyone who simply +wants to build up their open-source cred. + +* Issues labelled https://github.com/search?q=org%3Agithub%2Francher+repo%3Arancher%2Fturtles+repo%3Arancher%2Fcapi-ui-extension+repo%3Arancher%2Fturtles-docs+is%3Aopen+label%3A%22good+first+issue%22+&type=issues&ref=advsearch[`good first issues`] +should be accessible to folks new to the repos, as well as to open source in general. ++ +These issues should present a low/non-existent barrier to entry with a thorough description, +easy-to-follow reproduction (if relevant) and enough context for anyone to pick up. +The objective should be clear, possibly with a suggested solution or some pseudocode. +If anything similar has been done, that work should be linked. ++ +If you have come across an issue tagged with `good first issue` which you think you would +like to claim but isn't 100% clear, please ask for more info! When people write issues +there is a _lot_ of assumed knowledge which is very often taken for granted. This is +something we could all get better at, so don't be shy in asking for what you need +to do great work. ++ +See more on <<_asking_for_help,asking for help>> below! + +* https://github.com/search?q=org%3Agithub%2Francher+repo%3Arancher%2Fturtles+repo%3Arancher%2Fcapi-ui-extension+repo%3Arancher%2Fturtles-docs+is%3Aopen+label%3A%22help+wanted%22+&type=issues&ref=advsearch[`help wanted` issues] +are for those a little more familiar with the code base, but should still be accessible enough +to newcomers. +* All other issues labelled `kind/` or `area/` are also up for grabs, but +are likely to require a fair amount of context. + +=== Developing rancher-turtles + +Check out the dedicated xref:../developer-guide/development.adoc[notes] on getting started with development. + +=== Asking for help + +If you need help at any stage of your work, please don't hesitate to ask! + +* To get more detail on the issue you have chosen, it is a good idea to start by asking +whoever created it to provide more information. +* If you are struggling with something while working on your PR, or aren't quite +sure of your approach, you can open a https://github.blog/2019-02-14-introducing-draft-pull-requests/[draft] +(prefix the title with `WIP:`) and explain what you are thinking. + +=== PR submission guidelines + +. Fork the desired repo, develop and test your code changes. +. Push your changes to the branch on your fork and submit a pull request to the original repository +against the `main` branch. + +[source,bash] +---- +git push +---- + +. Submit a pull request. + .. All code PR must be labeled with one of + *** ⚠️ (`:warning:`, major or breaking changes) + *** ✨ (`:sparkles:`, feature additions) + *** 🐛 (`:bug:`, patch and bugfixes) + *** 📖 (`:book:`, documentation or proposals) + *** 🌱 (`:seedling:`, minor or other) + +Where possible, please squash your commits to ensure a tidy and descriptive history. + +If your PR is still a work in progress, please open a https://github.blog/2019-02-14-introducing-draft-pull-requests/[Draft PR] +and prefix your title with the word `WIP`. When your PR is ready for review, you +can change the title and remove the Draft setting. + +We recommend that you regularly rebase from `main` of the original repo to keep your +branch up to date. + +In general, we will merge a PR once a maintainer has reviewed and approved it. +Trivial changes (e.g., corrections to spelling) may get waved through. +For substantial changes, more people may become involved, and you might get asked to resubmit the PR or divide the changes into more than one PR. + +==== Commit message formatting + +_For more on how to write great commit messages, and why you should, check out +https://chris.beams.io/posts/git-commit/[this excellent blog post]._ + +We follow a rough convention for commit messages that is designed to answer three +questions: what changed, why was the change made, and how did you make it. + +The subject line should feature the _what_ and +the body of the commit should describe the _why_ and _how_. +If you encountered any weirdness along the way, this is a good place +to note what you discovered and how you solved it. + +The format can be described more formally as follows: + +[source,text] +---- + + + + + +