diff --git a/docs/README.md b/docs/README.md index 5e61097542..6760f554a8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,13 +5,14 @@ * [Quick Start](./basics/quick-start.md) * [Stack Graph](./basics/stack-graph.md) * [Using Garden](./using-garden/README.md) - * [Development workflows](./using-garden/development-workflows.md) - * [Configuration files](./using-garden/configuration-files.md) - * [Container modules](./using-garden/container-modules.md) + * [Development Workflows](./using-garden/development-workflows.md) + * [Configuration Files](./using-garden/configuration-files.md) + * [Container Modules](./using-garden/container-modules.md) * [Local Kubernetes](./using-garden/local-kubernetes.md) * [Remote Kubernetes](./using-garden/remote-kubernetes.md) - * [In-cluster building](./using-garden/in-cluster-building.md) - * [Using Helm charts](./using-garden/using-helm-charts.md) + * [In-cluster Building](./using-garden/in-cluster-building.md) + * [Cloud Provider Set-up](./using-garden/cloud-provider-setup.md) + * [Using Helm Charts](./using-garden/using-helm-charts.md) * [Hot Reload](./using-garden/hot-reload.md) * [Example projects](./examples/README.md) * [Demo project](./examples/demo-project.md) diff --git a/docs/using-garden/README.md b/docs/using-garden/README.md index aa7d2355d9..4ebf868220 100644 --- a/docs/using-garden/README.md +++ b/docs/using-garden/README.md @@ -1,14 +1,14 @@ # Using Garden -## [Development workflows](./development-workflows.md) +## [Development Workflows](./development-workflows.md) In this article we discuss how to set up a new Garden project, the basic development workflow, how Garden's providers work, and the basics of testing and dependencies. -## [Configuration files](./configuration-files.md) +## [Configuration Files](./configuration-files.md) This one is all about Garden's configuration files—an overview of project and module configs, setting up services, and a primer on tests. -## [Container modules](./container-modules.md) +## [Container Modules](./container-modules.md) One of the most commonly used module types for Garden is the `container` module type. This guide walks through its usage and configuration. @@ -22,16 +22,20 @@ common flavors of local Kubernetes setups, such as Minikube, Docker for Desktop Garden can also work smoothly with remote Kubernetes clusters. If you'd like to use a remote cluster, you may have some additional considerations and requirements. Take a look at this guide for details. -## [In-cluster building](./in-cluster-building.md) +## [In-cluster Building](./in-cluster-building.md) One of Garden's most powerful features is the ability to build images in your Kubernetes development cluster, thus avoiding the need for local Kubernetes clusters. This guide covers the requirements for in-cluster building and how to set it up. -## [Hot Reload](./hot-reload.md) +## [Cloud Provider Set-up](./using-helm-charts.md) -This article discusses how to use hot reloading, so that you can update running services on the fly as you make changes to their code, without losing state and without having to destroy and re-create containers. +Instructions for creating and configuring Kubernetes clusters with GKE (Google), AKS (Azure), EKS and kops (AWS), and how to connect to them with Garden. ## [Using Helm charts](./using-helm-charts.md) The [Helm](https://helm.sh/) package manager is one of the most commonly used tools for managing Kubernetes manifests. Garden supports using your own Helm charts, alongside your container modules. This guide shows you how to use 3rd-party (or otherwise external) Helm charts, as well as your own charts, in your Garden project. We also go through how to configure tests, tasks and hot-reloading for your charts. + +## [Hot Reload](./hot-reload.md) + +This article discusses how to use hot reloading, so that you can update running services on the fly as you make changes to their code, without losing state and without having to destroy and re-create containers.