diff --git a/docs/v0.15.0/antora.yml b/docs/v0.15.0/antora.yml new file mode 100644 index 00000000..0eaf9cb1 --- /dev/null +++ b/docs/v0.15.0/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/v0.15.0/modules/en/images/30000ft_view.png b/docs/v0.15.0/modules/en/images/30000ft_view.png new file mode 100644 index 00000000..7441fa1b Binary files /dev/null and b/docs/v0.15.0/modules/en/images/30000ft_view.png differ diff --git a/docs/v0.15.0/modules/en/images/capi_logo.svg b/docs/v0.15.0/modules/en/images/capi_logo.svg new file mode 100644 index 00000000..2133449f --- /dev/null +++ b/docs/v0.15.0/modules/en/images/capi_logo.svg @@ -0,0 +1 @@ +kubernetes-cluster-logos_final \ No newline at end of file diff --git a/docs/v0.15.0/modules/en/images/deployments-turtles.png b/docs/v0.15.0/modules/en/images/deployments-turtles.png new file mode 100644 index 00000000..c165360a Binary files /dev/null and b/docs/v0.15.0/modules/en/images/deployments-turtles.png differ diff --git a/docs/v0.15.0/modules/en/images/favicon.ico b/docs/v0.15.0/modules/en/images/favicon.ico new file mode 100644 index 00000000..630449c0 Binary files /dev/null and b/docs/v0.15.0/modules/en/images/favicon.ico differ diff --git a/docs/v0.15.0/modules/en/images/gh_clone.png b/docs/v0.15.0/modules/en/images/gh_clone.png new file mode 100644 index 00000000..1909eba2 Binary files /dev/null and b/docs/v0.15.0/modules/en/images/gh_clone.png differ diff --git a/docs/v0.15.0/modules/en/images/image.png b/docs/v0.15.0/modules/en/images/image.png new file mode 100644 index 00000000..2f4da268 Binary files /dev/null and b/docs/v0.15.0/modules/en/images/image.png differ diff --git a/docs/v0.15.0/modules/en/images/image1554.png b/docs/v0.15.0/modules/en/images/image1554.png new file mode 100644 index 00000000..0a074a55 Binary files /dev/null and b/docs/v0.15.0/modules/en/images/image1554.png differ diff --git a/docs/v0.15.0/modules/en/images/in_cluster_topology.png b/docs/v0.15.0/modules/en/images/in_cluster_topology.png new file mode 100644 index 00000000..7be5f6c9 Binary files /dev/null and b/docs/v0.15.0/modules/en/images/in_cluster_topology.png differ diff --git a/docs/v0.15.0/modules/en/images/install-turtles-from-ui.gif b/docs/v0.15.0/modules/en/images/install-turtles-from-ui.gif new file mode 100644 index 00000000..80f6880e Binary files /dev/null and b/docs/v0.15.0/modules/en/images/install-turtles-from-ui.gif differ diff --git a/docs/v0.15.0/modules/en/images/intro.png b/docs/v0.15.0/modules/en/images/intro.png new file mode 100644 index 00000000..49d88593 Binary files /dev/null and b/docs/v0.15.0/modules/en/images/intro.png differ diff --git a/docs/v0.15.0/modules/en/images/logo.svg b/docs/v0.15.0/modules/en/images/logo.svg new file mode 100644 index 00000000..e65404a5 --- /dev/null +++ b/docs/v0.15.0/modules/en/images/logo.svg @@ -0,0 +1,106 @@ + + + + + + + + + + + + + + diff --git a/docs/v0.15.0/modules/en/images/ns.png b/docs/v0.15.0/modules/en/images/ns.png new file mode 100644 index 00000000..b9b7ff41 Binary files /dev/null and b/docs/v0.15.0/modules/en/images/ns.png differ diff --git a/docs/v0.15.0/modules/en/images/rancher-logo-cow-blue.svg b/docs/v0.15.0/modules/en/images/rancher-logo-cow-blue.svg new file mode 100644 index 00000000..8353dec6 --- /dev/null +++ b/docs/v0.15.0/modules/en/images/rancher-logo-cow-blue.svg @@ -0,0 +1,26 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/v0.15.0/modules/en/images/sidebar.png b/docs/v0.15.0/modules/en/images/sidebar.png new file mode 100644 index 00000000..a7371d20 Binary files /dev/null and b/docs/v0.15.0/modules/en/images/sidebar.png differ diff --git a/docs/v0.15.0/modules/en/nav.adoc b/docs/v0.15.0/modules/en/nav.adoc new file mode 100644 index 00000000..8ec1c3fc --- /dev/null +++ b/docs/v0.15.0/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] +** xref:developer-guide/contributing_guidelines.adoc[Guidelines] +* Reference +** xref:reference/intro.adoc[Introduction] +** xref:reference/glossary.adoc[Glossary] +* Security +** xref:security/slsa.adoc[SLSA] \ No newline at end of file diff --git a/docs/v0.15.0/modules/en/pages/developer-guide/contributing_guidelines.adoc b/docs/v0.15.0/modules/en/pages/developer-guide/contributing_guidelines.adoc new file mode 100644 index 00000000..7c432aa8 --- /dev/null +++ b/docs/v0.15.0/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] +---- + + + + + +