Skip to content

Commit

Permalink
docs: fix redirects and update links
Browse files Browse the repository at this point in the history
  • Loading branch information
edvald authored and eysi09 committed Mar 19, 2020
1 parent 1bf7da9 commit 11a3f29
Show file tree
Hide file tree
Showing 33 changed files with 94 additions and 87 deletions.
49 changes: 28 additions & 21 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,31 @@ structure:
summary: docs/README.md

redirects:
guides/using-remote-sources: advanced/using-remote-sources.md
guides/cert-manager-integration: advanced/cert-manager-integration.md
providers/conftest-container: reference/providers/conftest-container.md
providers/conftest-kubernetes: reference/providers/conftest-kubernetes.md
providers/conftest: reference/providers/conftest.md
providers/hadolint: reference/providers/hadolint.md
providers/kubernetes: reference/providers/kubernetes.md
providers/local-kubernetes: reference/providers/local-kubernetes.md
providers/maven-container: reference/providers/maven-container.md
providers/openfaas: reference/providers/openfaas.md
providers/terraform: reference/providers/terraform.md
module-types/conftest: reference/module-types/conftest.md
module-types/container: reference/module-types/container.md
module-types/exec: reference/module-types/exec.md
module-types/hadolint: reference/module-types/hadolint.md
module-types/helm: reference/module-types/helm.md
module-types/kubernetes: reference/module-types/kubernetes.md
module-types/maven-container: reference/module-types/maven-container.md
module-types/openfaas: reference/module-types/openfaas.md
module-types/persistentvolumeclaim: reference/module-types/persistentvolumeclaim.md
module-types/terraform: reference/module-types/terraform.md
installation: ./docs/basics/installation.md
quick-start: ./docs/basics/quick-start.md
stack-graph: ./docs/basics/stack-graph.md
troubleshooting: ./docs/misc/troubleshooting.md
examples/demo-project: ./docs/example-projects/demo-project.md
examples/tls-project: ./docs/example-projects/tls-project.md
examples/using-garden-in-ci: ./docs/example-projects/using-garden-in-ci.md
guides/using-remote-sources: ./docs/advanced/using-remote-sources.md
guides/cert-manager-integration: ./docs/advanced/cert-manager-integration.md
providers/conftest-container: ./docs/reference/providers/conftest-container.md
providers/conftest-kubernetes: ./docs/reference/providers/conftest-kubernetes.md
providers/conftest: ./docs/reference/providers/conftest.md
providers/hadolint: ./docs/reference/providers/hadolint.md
providers/kubernetes: ./docs/reference/providers/kubernetes.md
providers/local-kubernetes: ./docs/reference/providers/local-kubernetes.md
providers/maven-container: ./docs/reference/providers/maven-container.md
providers/openfaas: ./docs/reference/providers/openfaas.md
providers/terraform: ./docs/reference/providers/terraform.md
module-types/conftest: ./docs/reference/module-types/conftest.md
module-types/container: ./docs/reference/module-types/container.md
module-types/exec: ./docs/reference/module-types/exec.md
module-types/hadolint: ./docs/reference/module-types/hadolint.md
module-types/helm: ./docs/reference/module-types/helm.md
module-types/kubernetes: ./docs/reference/module-types/kubernetes.md
module-types/maven-container: ./docs/reference/module-types/maven-container.md
module-types/openfaas: ./docs/reference/module-types/openfaas.md
module-types/persistentvolumeclaim: ./docs/reference/module-types/persistentvolumeclaim.md
module-types/terraform: ./docs/reference/module-types/terraform.md
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
- Easily write [integration test suites](https://docs.garden.io/guides/development-workflows#tests-and-dependencies) that have runtime dependencies. Run tests *before* pushing your code to CI, and avoid having to mock or stub your own services.
- Define [tasks](https://github.com/garden-io/garden/tree/v0.11.8/examples/tasks) that run as part of your deployment process—e.g. database migrations or scaffolding.
- [Hot reload](https://docs.garden.io/guides/hot-reload) lets you near-instantaneously update code and static files in containers as they run, for services that support in-place reloading.
- [Remote sources](https://docs.garden.io/guides/using-remote-sources) support allows your project to automatically pull code from different repositories.
- [Remote sources](https://docs.garden.io/advanced/using-remote-sources) support allows your project to automatically pull code from different repositories.
- The built-in web **dashboard** gives you a full overview of your stack (and many more UI features are planned to further aid with development).
- Build, test and deploy Docker containers, [Helm charts](https://docs.garden.io/guides/using-helm-charts), OpenFaaS functions and more.
- An extensible plug-in system ensures you’ll later be able add anything that’s not on the above list, or create custom module types tailored to your needs (*due summer 2019*).
Expand Down Expand Up @@ -51,7 +51,7 @@

## Quick start

With the CLI installed, you can try out a few commands using the [Demo Project](https://docs.garden.io/examples/demo-project) from our [example projects](https://github.com/garden-io/garden/tree/v0.11.8/examples). The example project consists of a couple of simple modules, each defining one service.
With the CLI installed, you can try out a few commands using the [Demo Project](https://docs.garden.io/example-projects/demo-project) from our [example projects](https://github.com/garden-io/garden/tree/v0.11.8/examples). The example project consists of a couple of simple modules, each defining one service.

*Note: This example assumes you have a local Kubernetes instance running.*

Expand Down Expand Up @@ -96,7 +96,7 @@ Overview:

- [Using Garden](https://docs.garden.io/using-garden)—short Guides on incrementally adding the main Garden constructs to your project.
- [Guides](https://docs.garden.io/guides)—development workflows, Garden configuration files, usage with remote Kubernetes clusters, and setting up hot reload.
- [Example Projects](https://docs.garden.io/examples)—guides based on some of the [examples](https://github.com/garden-io/garden/tree/v0.11.8/examples).
- [Example Projects](https://docs.garden.io/example-projects)—guides based on some of the [examples](https://github.com/garden-io/garden/tree/v0.11.8/examples).
- [Reference](https://docs.garden.io/reference)—glossary, commands reference, configuration files reference, and template strings reference.
- [FAQs](https://docs.garden.io/#faqs).

Expand All @@ -106,7 +106,7 @@ The [examples](https://github.com/garden-io/garden/tree/v0.11.8/examples) folder

Garden runs as a developer tool on your machine or in CI, that looks at your source code and configuration files, runs tests, and resolves your changes to update your development environment. Garden can watch your files and run continuously, or you can trigger it manually via the CLI.

For configuration, Garden is centered around the **[Stack Graph](https://docs.garden.io/stack-graph)**, which allows you to fully codify how each part of your stack is built, deployed and tested—making your workflow reproducible and portable.
For configuration, Garden is centered around the **[Stack Graph](https://docs.garden.io/basics/stack-graph)**, which allows you to fully codify how each part of your stack is built, deployed and tested—making your workflow reproducible and portable.

<p align="center">
<img src="docs/stack-graph.png" width="50%">
Expand All @@ -119,7 +119,7 @@ With the Stack Graph, each part of your stack can *describe itself* using simple
<details>
<summary><b>Is Garden a CI platform/tool?</b></summary>

Not exactly, but you can certainly use Garden to make your CI faster and easier to work with. We highly recommend [running Garden from your CI setup](https://docs.garden.io/examples/using-garden-in-ci), so that you can re-use the same structure and config, as well as your build and test result caches (if you're using shared dev clusters).
Not exactly, but you can certainly use Garden to make your CI faster and easier to work with. We highly recommend [running Garden from your CI setup](https://docs.garden.io/example-projects/using-garden-in-ci), so that you can re-use the same structure and config, as well as your build and test result caches (if you're using shared dev clusters).
</details>
<br>
<details>
Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@

## 🌺 Example Projects

* [Demo Project](./examples/demo-project.md)
* [TLS Project](./examples/tls-project.md)
* [Using Garden in CI](./examples/using-garden-in-ci.md)
* [Demo Project](./example-projects/demo-project.md)
* [TLS Project](./example-projects/tls-project.md)
* [Using Garden in CI](./example-projects/using-garden-in-ci.md)

## ☘️ Reference

Expand Down
4 changes: 2 additions & 2 deletions docs/basics/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](../example-projects/demo-project.md) from our [example projects](../example-projects/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 @@ -79,4 +79,4 @@ That's it for now. Check out our [Using Garden](../guides/README.md) section for

## 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](../example-projects/demo-project.md) guide for a more in-depth presentation.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/guides/configuration-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -415,7 +415,7 @@ If you're using Git submodules in your project, please note the following:

We highly recommend reading the [Variables and Templating guide](./variables-and-templating.md) to understand how you can reference across different providers and modules, as well as to understand how to supply secret values to your configuration.

We suggest browsing through the [Example projects](../examples/README.md) as well, to see different examples of how projects and modules can be configured.
We suggest browsing through the [Example projects](../example-projects/README.md) as well, to see different examples of how projects and modules can be configured.

Also, be sure to look at the [Config Files Reference](../reference/config.md) for more details on each of the available configuration fields, and the [Template Strings Reference](../reference/template-strings.md) for the keys available in template strings.

Expand Down
4 changes: 2 additions & 2 deletions docs/guides/development-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
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.

We'll keep using the [Demo Project](../examples/demo-project.md) example, but the same principles will apply for most
We'll keep using the [Demo Project](../example-projects/demo-project.md) example, but the same principles will apply for most
Garden projects.

## garden dev
Expand All @@ -15,7 +15,7 @@ When you start it, `garden dev` will start your development environment and run
changes. When you then make changes, Garden re-builds, re-deploys, and re-tests the modules/services that are affected,
based on the dependency graph.

For example, if we run `garden dev` inside the [Demo Project](../examples/demo-project.md), the output should be
For example, if we run `garden dev` inside the [Demo Project](../example-projects/demo-project.md), the output should be
something like this:

```plain
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/variables-and-templating.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ Here the output from `prep-task` is copied to an environment variable for `my-se

For a practical use case, you might for example make a task that provisions some infrastructure or prepares some data, and then passes information about it to services.

Different module types expose different output keys for their services and tasks. Please refer to the [module type reference docs](https://docs.garden.io/module-types) for details.
Different module types expose different output keys for their services and tasks. Please refer to the [module type reference docs](https://docs.garden.io/reference/module-types) for details.

## Next steps

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/module-types/conftest.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tocTitle: "`conftest`"
Creates a test that runs `conftest` on the specified files, with the specified (or default) policy and
namespace.

> Note: In many cases, you'll let specific conftest providers (e.g. [`conftest-container`](https://docs.garden.io/reference/module-types/conftest-container) and [`conftest-kubernetes`](https://docs.garden.io/reference/module-types/conftest-kubernetes) create this module type automatically, but you may in some cases want or need to manually specify files to test.
> Note: In many cases, you'll let specific conftest providers (e.g. [`conftest-container`](https://docs.garden.io/reference/providers/conftest-container) and [`conftest-kubernetes`](https://docs.garden.io/reference/providers/conftest-kubernetes) create this module type automatically, but you may in some cases want or need to manually specify files to test.
See the [conftest docs](https://github.com/instrumenta/conftest) for details on how to configure policies.

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/module-types/maven-container.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ tocTitle: "`maven-container`"

## Description

A specialized version of the [container](https://docs.garden.io/module-types/container) module type
A specialized version of the [container](https://docs.garden.io/reference/module-types/container) module type
that has special semantics for JAR files built with Maven.

Rather than build the JAR inside the container (or in a multi-stage build) this plugin runs `mvn package`
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/providers/conftest.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ tocTitle: "`conftest`"

This provider allows you to validate your configuration files against policies that you specify, using the [conftest tool](https://github.com/instrumenta/conftest) and Open Policy Agent rego query files. The provider creates a module type of the same name, which allows you to specify files to validate. Each module then creates a Garden test that becomes part of your Stack Graph.

Note that, in many cases, you'll actually want to use more specific providers that can automatically configure your `conftest` modules, e.g. the [`conftest-container`](https://docs.garden.io/reference/module-types/conftest-container) and/or [`conftest-kubernetes`](https://docs.garden.io/reference/module-types/conftest-kubernetes) providers. See the [conftest example project](https://github.com/garden-io/garden/tree/v0.11.8/examples/conftest) for a simple usage example of the latter.
Note that, in many cases, you'll actually want to use more specific providers that can automatically configure your `conftest` modules, e.g. the [`conftest-container`](https://docs.garden.io/reference/providers/conftest-container) and/or [`conftest-kubernetes`](https://docs.garden.io/reference/providers/conftest-kubernetes) providers. See the [conftest example project](https://github.com/garden-io/garden/tree/v0.11.8/examples/conftest) for a simple usage example of the latter.

If those don't match your needs, you can use this provider directly and manually configure your `conftest` modules. Simply add this provider to your project configuration, and see the [conftest module documentation](https://docs.garden.io/reference/module-types/conftest) for a detailed reference. Also, check out the below reference for how to configure default policies, default namespaces, and test failure thresholds for all `conftest` modules.

Expand Down
14 changes: 7 additions & 7 deletions docs/reference/providers/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Kubernetes clusters, and adds the [`helm`](https://docs.garden.io/reference/modu

For usage information, please refer to the [guides section]https://docs.garden.io/guides). A good place to start is
the [Remote Kubernetes guide](https://docs.garden.io/guides/remote-kubernetes) guide if you're connecting to remote clusters.
The [demo-project](https://docs.garden.io/examples/demo-project) example project and guide are also helpful as an introduction.
The [demo-project](https://docs.garden.io/example-projects/demo-project) example project and guide are also helpful as an introduction.

Note that if you're using a local Kubernetes cluster (e.g. minikube or Docker Desktop), the [local-kubernetes provider](https://docs.garden.io/reference/providers/local-kubernetes) simplifies (and automates) the configuration and setup quite a bit.

Expand Down Expand Up @@ -214,14 +214,14 @@ providers:

# Set to `cert-manager` to configure [cert-manager](https://github.com/jetstack/cert-manager) to manage this
# certificate. See our
# [cert-manager integration guide](https://docs.garden.io/guides/cert-manager-integration) for details.
# [cert-manager integration guide](https://docs.garden.io/advanced/cert-manager-integration) for details.
managedBy:

# cert-manager configuration, for creating and managing TLS certificates. See the
# [cert-manager guide](https://docs.garden.io/guides/cert-manager-integration) for details.
# [cert-manager guide](https://docs.garden.io/advanced/cert-manager-integration) for details.
certManager:
# Automatically install `cert-manager` on initialization. See the
# [cert-manager integration guide](https://docs.garden.io/guides/cert-manager-integration) for details.
# [cert-manager integration guide](https://docs.garden.io/advanced/cert-manager-integration) for details.
install: false

# The email to use when requesting Let's Encrypt certificates.
Expand Down Expand Up @@ -1092,7 +1092,7 @@ The namespace where the secret is stored. If necessary, the secret may be copied

Set to `cert-manager` to configure [cert-manager](https://github.com/jetstack/cert-manager) to manage this
certificate. See our
[cert-manager integration guide](https://docs.garden.io/guides/cert-manager-integration) for details.
[cert-manager integration guide](https://docs.garden.io/advanced/cert-manager-integration) for details.

| Type | Required |
| -------- | -------- |
Expand All @@ -1111,7 +1111,7 @@ providers:
[providers](#providers) > certManager

cert-manager configuration, for creating and managing TLS certificates. See the
[cert-manager guide](https://docs.garden.io/guides/cert-manager-integration) for details.
[cert-manager guide](https://docs.garden.io/advanced/cert-manager-integration) for details.

| Type | Required |
| -------- | -------- |
Expand All @@ -1122,7 +1122,7 @@ cert-manager configuration, for creating and managing TLS certificates. See the
[providers](#providers) > [certManager](#providerscertmanager) > install

Automatically install `cert-manager` on initialization. See the
[cert-manager integration guide](https://docs.garden.io/guides/cert-manager-integration) for details.
[cert-manager integration guide](https://docs.garden.io/advanced/cert-manager-integration) for details.

| Type | Default | Required |
| --------- | ------- | -------- |
Expand Down
Loading

0 comments on commit 11a3f29

Please sign in to comment.