diff --git a/docs/k8s-plugins/about.md b/docs/k8s-plugins/about.md index 2be7fb41a2..3b39f788af 100644 --- a/docs/k8s-plugins/about.md +++ b/docs/k8s-plugins/about.md @@ -5,10 +5,11 @@ order: 1 # About -Garden has two Kubernetes plugins: +Garden has three Kubernetes plugins: - The `local-kubernetes` plugin is for local installations of Kubernetes such as Minikube or Docker for Desktop. - The `kubernetes` plugin works with any Kubernetes cluster. +- The `ephemeral-kubernetes` plugin is for spinning up a zero-config, temporary Garden managed Kubernetes cluster. The following pages provide step-by-step guides for getting started with either plugin. You can skip any steps you've already completed. @@ -22,4 +23,4 @@ For tests and tasks, Garden spins up Pods from the respective image that execute For live code synchronization, Garden uses a tool called Mutagen to sync changes to the running container. -There's a lot more to the Kubernetes plugin and if you're interested in the "nitty-gritty", we're more than happy to answer questions us on our [Discord channel](https://discord.gg/FrmhuUjFs6). +There's a lot more to the Kubernetes plugins and if you're interested in the "nitty-gritty", we're more than happy to answer questions us on our [Discord channel](https://discord.gg/FrmhuUjFs6). diff --git a/docs/welcome.md b/docs/welcome.md index ff8a2d27cd..e49901cfea 100644 --- a/docs/welcome.md +++ b/docs/welcome.md @@ -1,23 +1,102 @@ --- order: 0 -title: Welcome! +title: Welcome to Garden! +description: >- + Garden is a DevOps automation tool for developing and testing apps that run on + Kubernetes faster. --- -# Welcome! -Welcome to the official Garden documentation site 👋 +# Welcome to Garden! -Here you'll find (hopefully) everything you need to know on how to set up and use Garden for your development and testing workflows. +Garden lets you spin up **production-like environments** for development, testing, and CI **on demand**. It enables teams to use the **same configuration** and workflows for **every stage of software delivery**—and dramatically **speeds up builds and test runs** via smart caching. -**If you're new to Garden and are working on setting up your project**, we recommend the following: +If there's something you can't find in our docs, we happily encourage you to [join our Discord community](https://discord.gg/FrmhuUjFs6) and/or file an issue on [our GitHub repo](https://github.com/garden-io/garden). We're more than happy to help! -* Start by going through our [Quickstart Guide](./getting-started/quickstart.md). This will give you a basic overview of Garden's main features. -* Next, go through the [Your First Project tutorial](./tutorials/your-first-project/README.md). This tutorial helps you create configuration for an example project that you can then apply to your own. And if you get stuck, don't hesitate to reach out to our [our Discord community](https://discord.gg/FrmhuUjFs6). -* Finally, check-out our [Adopting Garden guide](./overview/adopting-garden.md) which gives you a high-level overview of how to adopt Garden and roll it out to your team. +### Overview -**If your team has already set up a project for Garden**, and you just need to learn how to use the Garden CLI, you may find it helpful to skip straight to the [Installation](./getting-started/quickstart.md#step-1-install-garden) and [Using the CLI](./using-garden/using-the-cli.md) guides, but we do still recommend learning [How Garden Works](./overview/how-garden-works.md) and about [the core Garden concepts](./overview/core-concepts.md). + + + + + + + + + + + + + + + + + + + + + + + + + +
+ How Garden Works + A quick introduction to the how and why of GardenHow Garden Works
Use CasesLearn how teams use Garden in the real world to deliver cloud native apps fasterUse Cases
Garden vs Other ToolsThe cloud native tooling space is complex—learn where Garden fits inGarden vs Other Tools
-**If you need help as an open source user**, please get in touch via [our Discord community](https://discord.gg/FrmhuUjFs6). Our team monitors it closely, and we encourage you to reach out with questions about Garden. +### Getting Started -**If you'd like to learn more about Garden Cloud**, please see [our website](https://garden.io/plans). + + + + + + + + + + + + + + + + + + + + + + + + + +
QuickstartGet started with Garden in less than 5 minutes using our example projectQuickstart Guide
Adopting GardenOnce you've kicked the tires with our quickstart example, come here to learn how to adopt Garden for your own projectAdopting Garden
"First Project" TutorialThis tutorial walks through the step-by-step process of configuring your first Garden projectYour First Project
-If there's something you can't find in our docs, we happily encourage you to [join our Discord community](https://discord.gg/FrmhuUjFs6) and/or file an issue on [our GitHub repo](https://github.com/garden-io/garden). We're more than happy to help! +### Using Garden + + + + + + + + + + + + + + + + + + + + + + + + + + +
Configuration OverviewAn introduction to how Garden projects are configuredConfiguration Overview
Kubernetes PluginsMost users come to Garden for our K8s plugins, here you learn how to set them upKubernetes
Reference docsThe pages in this section container reference docs for different plugins and actions types🪷 Reference