Skip to content

Commit

Permalink
chore: fix links (TBS)
Browse files Browse the repository at this point in the history
  • Loading branch information
eysi09 committed Nov 6, 2019
1 parent 6a41780 commit 802b05b
Show file tree
Hide file tree
Showing 10 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions docs/examples/demo-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ In what follows you'll learn how to:

## Before you get started

This tutorial assumes that you already have a running [installation of Garden](../basics/installation.md).
This tutorial assumes that you already have a running [installation of Garden](../installation.md).

## Clone the example repo

Expand Down Expand Up @@ -76,7 +76,7 @@ Above, we've specified the name of our project and configured it to use the `loc

## Module configuration

Now, let's turn to our services. Services live inside [modules](../reference/glossary.md#Module), and each module has its own `garden.yml` configuration file. You can read more about the difference between services and modules [here](../basics/stack-graph.md#structure-and-terminology).
Now, let's turn to our services. Services live inside [modules](../reference/glossary.md#Module), and each module has its own `garden.yml` configuration file. You can read more about the difference between services and modules [here](../stack-graph.md#structure-and-terminology).

We'll start with the module for the `frontend`:

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/configuration-files.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Configuration Files

Garden is configured via `garden.yml` configuration files, which Garden collects and compiles into a
[Stack Graph](../basics/stack-graph.md) of your project.
[Stack Graph](../stack-graph.md) of your project.

The [project-wide](#project-configuration) `garden.yml` file should be located in the top-level directory of the
project's Git repository.
Expand Down
4 changes: 2 additions & 2 deletions docs/guides/development-workflows.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Development Workflows

Now that you've had a glimpse of the basic Garden commands in the [Quick Start](../basics/quick-start.md) guide, and
learned about the [Stack Graph](../basics/stack-graph.md), let's go through some typical Garden workflows.
Now that you've had a glimpse of the basic Garden commands in the [Quick Start](../quick-start.md) guide, and
learned about the [Stack Graph](../stack-graph.md), let's go through some typical Garden workflows.

We'll keep using the [Demo Project](../examples/demo-project.md) example, but the same principles will apply for most
Garden projects.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/local-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ If you happen to have installed both Minikube and a version of Docker for Mac wi
is set as the current context, the first available context is used.

(If you're not yet familiar with Garden configuration files, see:
[Configuration files](../using-garden/configuration-files.md))
[Configuration files](../guides/configuration-files.md))
10 changes: 5 additions & 5 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Please follow the guide for your operating system:
* [Windows](#windows)
* [Linux](#linux)

If you'd like to run Kubernetes locally, please see our [local Kubernetes guide](../guides/local-kubernetes.md)
If you'd like to run Kubernetes locally, please see our [local Kubernetes guide](./guides/local-kubernetes.md)
for installation and usage information.

If you want to install Garden from source, see the instructions in our [contributor guide](https://github.com/garden-io/garden/tree/master/CONTRIBUTING.md).
Expand Down Expand Up @@ -53,16 +53,16 @@ To install Docker, Kubernetes and kubectl, we recommend Docker for Mac.

Please refer to their [installation guide](https://docs.docker.com/engine/installation/) for how to download and install it (which is a pretty simple process).

If you'd like to use a local Kubernetes cluster, please refer to the [local Kubernetes guide](../guides/local-kubernetes.md)
If you'd like to use a local Kubernetes cluster, please refer to the [local Kubernetes guide](./guides/local-kubernetes.md)
for further information.

## Windows

You can run Garden on Windows 10 Home, Pro or Enterprise editions.

_Note: The Home edition doesn't support virtualization, but you can still use Garden if you're working with
[remote Kubernetes](../guides/remote-kubernetes.md) and
[in-cluster building](../guides/in-cluster-building.md)._
[remote Kubernetes](./guides/remote-kubernetes.md) and
[in-cluster building](./guides/in-cluster-building.md)._

To install the Garden CLI and its dependencies, please use our installation script. To run the script, open PowerShell as an administrator and run:

Expand Down Expand Up @@ -119,7 +119,7 @@ To install Docker, please follow the instructions in the [official documentation

### Step 4 (optional): Local Kubernetes

If you'd like to use a local Kubernetes cluster, please refer to the [local Kubernetes guide](../guides/local-kubernetes.md)
If you'd like to use a local Kubernetes cluster, please refer to the [local Kubernetes guide](./guides/local-kubernetes.md)
for installation and usage information.

## Using Garden with proxies
Expand Down
6 changes: 3 additions & 3 deletions docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This guide will walk you through setting up the Garden framework. It assumes you

## Using the CLI

With the CLI installed, we can now try out a few commands using the [Demo Project](../examples/demo-project.md) from our [example projects](../examples/README.md). The example project consists of a couple of basic modules, each defining one service.
With the CLI installed, we can now try out a few commands using the [Demo Project](./examples/demo-project.md) from our [example projects](./examples/README.md). The example project consists of a couple of basic modules, each defining one service.

_Note: Check whether Kubernetes is running with `kubectl version`. You should see both a `Client Version` and a `Server Version` in the response. If not, please start it up before proceeding._

Expand Down Expand Up @@ -72,8 +72,8 @@ garden dev

Go ahead, leave it running and change one of the files in the project, then watch it re-build.

That's it for now. Check out our [Using Garden](../guides/README.md) section for other features like hot reload, remote clusters, integration tests, and lots more.
That's it for now. Check out our [Using Garden](./guides/README.md) section for other features like hot reload, remote clusters, integration tests, and lots more.

## Next steps

To see how a Garden project is configured from scratch check, out the [Demo Project](../examples/demo-project.md) guide for a more in-depth presentation.
To see how a Garden project is configured from scratch check, out the [Demo Project](./examples/demo-project.md) guide for a more in-depth presentation.
2 changes: 1 addition & 1 deletion docs/reference/providers/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Set a default username (used for namespacing within a cluster).
### `providers[].deploymentStrategy`

[providers](#providers) > deploymentStrategy
> ⚠️ **Experimental**: this is an experimental feature and the API might change in the future.
> ⚠️ **Experimental**: this is an experimental feature and the API might change in the future.

Defines the strategy for deploying the project services.
Default is "rolling update" and there is experimental support for "blue/green" deployment.
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/providers/local-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Set a default username (used for namespacing within a cluster).
### `providers[].deploymentStrategy`

[providers](#providers) > deploymentStrategy
> ⚠️ **Experimental**: this is an experimental feature and the API might change in the future.
> ⚠️ **Experimental**: this is an experimental feature and the API might change in the future.

Defines the strategy for deploying the project services.
Default is "rolling update" and there is experimental support for "blue/green" deployment.
Expand Down
2 changes: 1 addition & 1 deletion docs/stack-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ Note here the first four fields, which are common across all module types—`kin
Also notice that the `container` module explicitly declares a service, whereas the `helm` module does not. This is dictated by the module
type. Containers often only need to be built (e.g. base images for other containers), or may contain multiple services. A Helm chart, however, is generally a single deployable so the provider makes the service implicit when configuring it.

For more details on how to configure your project, take a look at the [configuration guide](../guides/configuration-files.md).
For more details on how to configure your project, take a look at the [configuration guide](./guides/configuration-files.md).
2 changes: 1 addition & 1 deletion docs/using-garden/creating-a-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ services:
## Further Reading

* [Full project config reference](../reference/config.md).
* [A guide on template strings and setting project wide variables](../guides/variables-and-templating.m).
* [A guide on template strings and setting project wide variables](../guides/variables-and-templating.md).
* [Template string reference](../reference/template-strings.md).

## Next Steps
Expand Down

0 comments on commit 802b05b

Please sign in to comment.