From cddb302d19e9d3cc94730be4116aedc49a8c0d8f Mon Sep 17 00:00:00 2001 From: Jon Edvald Date: Mon, 24 Jun 2019 00:20:29 +0200 Subject: [PATCH] docs: fix some broken links --- docs/examples/demo-project.md | 2 +- docs/using-garden/configuration-files.md | 5 +++-- docs/using-garden/remote-clusters.md | 8 ++++---- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/examples/demo-project.md b/docs/examples/demo-project.md index 4329104c22..63c7785f7b 100644 --- a/docs/examples/demo-project.md +++ b/docs/examples/demo-project.md @@ -17,7 +17,7 @@ This tutorial assumes that you already have a running [installation of Garden](. ## Clone the example repo -The code for this tutorial can be found in our Github repository under the [examples directory](https://github.com/garden-io/garden/tree/v0.9.12/examples). We'll use the [demo-project-start](https://github.com/garden-io/garden/tree/v0.9.12/examples/demo-project-start/) example and work our way from there. The final version is under [demo-project](https://github.com/garden-io/garden/tree/v0.9.12/examples/demo-project). +The code for this tutorial can be found in our Github repository under the [examples directory](https://github.com/garden-io/garden/tree/v0.10.0-0/examples). We'll use the [demo-project-start](https://github.com/garden-io/garden/tree/v0.10.0-0/examples/demo-project-start/) example and work our way from there. The final version is under [demo-project](https://github.com/garden-io/garden/tree/v0.10.0-0/examples/demo-project). First, let's clone the examples repo, change into the directory, and take a look inside: diff --git a/docs/using-garden/configuration-files.md b/docs/using-garden/configuration-files.md index 5c342d8c90..9f08349399 100644 --- a/docs/using-garden/configuration-files.md +++ b/docs/using-garden/configuration-files.md @@ -15,7 +15,8 @@ To decide how to split your project up into modules, it's useful to consider wha step, and what the dependency relationships are between your build steps. For example, each container and each serverless function should be represented by its own module. -Below, we'll be using examples from the [OpenFaaS](../examples/openfaas.md) example project. +Below, we'll be using examples from the +[OpenFaaS](https://github.com/garden-io/garden/blob/master/examples/openfaas/garden.yml) example project. ## Project Configuration @@ -50,7 +51,7 @@ For example, assuming the above project configuration, `"foo-${var.my-variable}- ## Module Configuration Below, we'll use the module configurations of `hello-function` and `hello-container` from the -[OpenFaaS](../examples/openfaas.md) example project +[OpenFaaS](https://github.com/garden-io/garden/blob/master/examples/openfaas/garden.yml) example project as examples to illustrate some of the primary module-level configuration options. The following is a snippet from `hello-container`'s module config: diff --git a/docs/using-garden/remote-clusters.md b/docs/using-garden/remote-clusters.md index 2eff1ee339..a8700c1b4f 100644 --- a/docs/using-garden/remote-clusters.md +++ b/docs/using-garden/remote-clusters.md @@ -75,8 +75,8 @@ and a couple of small utility services. Make sure your cluster has enough resources and storage to support the required services, and keep in mind that these services are shared across all users of the cluster. Please look at the -[resources](../reference/providers/kubernetes#providers[].resources) and -[storage](../reference/providers/kubernetes#providers[].storage) sections in the provider reference for +[resources](../reference/providers/kubernetes.md#providers[].resources) and +[storage](../reference/providers/kubernetes.md#providers[].storage) sections in the provider reference for details. ### Kaniko @@ -95,7 +95,7 @@ The trade-off is generally in performance, at least for the moment, partly becau cache layers. There are also some known issues and incompatibilities, so your mileage may vary. Note the difference in how resources for the builder are allocated. See the -[builder resources](../reference/providers/kubernetes#providers[].resources.builder) reference for details. +[builder resources](../reference/providers/kubernetes.md#providers[].resources.builder) reference for details. ### Local Docker @@ -147,7 +147,7 @@ to your registry's documentation on how to do that (for Docker Hub you simply ru ### Ingress, TLS and DNS -By default, Garden will not install an ingress controller for remote environments. This can be toggled by setting the [`setupIngressController` flag](../reference/providers/kubernetes#providers[].setupingresscontroller) to `nginx`. Alternatively, you can set up your own ingress controller, e.g. using [Traefik](https://traefik.io/), [Ambassador](https://www.getambassador.io/) or [Istio](https://istio.io/). You can find examples for [using Garden with Ambassador](https://github.com/garden-io/garden/tree/v0.9.12/examples/ambassador) and [with Istio](https://github.com/garden-io/garden/tree/v0.9.12/examples/istio) in our [examples directory](https://github.com/garden-io/garden/tree/master/examples). +By default, Garden will not install an ingress controller for remote environments. This can be toggled by setting the [`setupIngressController` flag](../reference/providers/kubernetes.md#providers[].setupingresscontroller) to `nginx`. Alternatively, you can set up your own ingress controller, e.g. using [Traefik](https://traefik.io/), [Ambassador](https://www.getambassador.io/) or [Istio](https://istio.io/). You can find examples for [using Garden with Ambassador](https://github.com/garden-io/garden/tree/v0.9.12/examples/ambassador) and [with Istio](https://github.com/garden-io/garden/tree/v0.9.12/examples/istio) in our [examples directory](https://github.com/garden-io/garden/tree/master/examples). You'll also need to point one or more DNS entries to your cluster, and configure a TLS certificate for the hostnames you will expose for ingress.