Skip to content

Commit

Permalink
docs: Fix broken readme links (#909)
Browse files Browse the repository at this point in the history
* docs: broken link to example directory
* docs: fix broken readme links
  • Loading branch information
baspetersdotjpeg authored and benstov committed Jun 28, 2019
1 parent 0d195fa commit ed0233b
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
- Spin up your whole stack with a single command, and (optionally) watch for changes. Only what’s needed gets re-built, re-deployed, and/or re-tested, so you get a **much faster feedback loop**.
- **Shared development clusters with fast in-cluster building and image caching for Kubernetes.** This allows teams to easily share build and test results, and for CI to become much faster because it can use the same build and test caches as the team.
- Get helpful information when your deployments fail. Garden collects events and logs and displays them prominently when issues come up, and strives to "fail fast", so that you don't need to wait for timeouts or dive into kubectl whenever something is wrong.
- Easily write [integration test suites](https://docs.garden.io/using-garden/features-and-usage#testing-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.9.12/examples/tasks) that run as part of your deployment process—e.g. database migrations or scaffolding.
- Easily write [integration test suites](https://docs.garden.io/using-garden/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/master/examples/tasks) that run as part of your deployment process—e.g. database migrations or scaffolding.
- [Hot reload](https://docs.garden.io/using-garden/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/examples/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).
Expand Down Expand Up @@ -53,7 +53,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.md) from our [example projects](../examples/README.md). 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/examples/demo-project) from our [example projects](https://github.com/garden-io/garden/tree/master/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 @@ -100,9 +100,9 @@ Overview:
- [Using Garden](https://docs.garden.io/using-garden)—features and usage, Garden configuration files, usage with remote 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.9.12/examples).
- [Reference](https://docs.garden.io/reference)—glossary, commands reference, configuration files reference, and template strings reference.
- [FAQs](https://docs.garden.io/faqs).
- [FAQs](https://docs.garden.io/#faqs).

The [examples](https://github.com/garden-io/garden/tree/v0.9.12/examples) folder of our repository also shows a myriad of different ways to use Garden. Check out the README in each example for more information
The [examples](https://github.com/garden-io/garden/tree/master/examples) folder of our repository also shows a myriad of different ways to use Garden. Check out the README in each example for more information

## How does it work?

Expand Down

0 comments on commit ed0233b

Please sign in to comment.