Skip to content

Commit

Permalink
docs: minor fixes to page titles (#5064)
Browse files Browse the repository at this point in the history
  • Loading branch information
eysi09 authored Sep 12, 2023
1 parent 7ef4e70 commit 83efcf4
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 16 deletions.
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,14 @@
## 🌺 Terraform Plugin

* [About](./terraform-plugin/about.md)
* [Provider Configuration](./terraform-plugin/configure-provider.md)
* [Deploy action Configuration](./terraform-plugin/configure-deploy-actions.md)
* [Plugin Configuration](./terraform-plugin/configure-provider.md)
* [Action Configuration](./terraform-plugin/action-configuration.md)

## ☘️ Pulumi Plugin

* [About](./pulumi-plugin/about.md)
* [Provider Configuration](./pulumi-plugin/configure-provider.md)
* [Deploy action Configuration](./pulumi-plugin/configure-deploy-actions.md)
* [Plugin Configuration](./pulumi-plugin/configure-provider.md)
* [Action Configuration](./pulumi-plugin/action-configuration.md)

## 🌹 Other Plugins

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
---
title: Deploy action Configuration
title: Action Configuration
order: 2
---

# Deploy action Configuration
# Action Configuration

You need to write Garden deploy action configs next to the pulumi stacks you'd like to include in your project. These should be located in the same directory as the stack config, or in an enclosing directory.
## Deploy Action

You need to write Garden Deploy action configs next to the pulumi stacks you'd like to include in your project. These should be located in the same directory as the stack config, or in an enclosing directory.

For example:
```yaml
Expand Down
10 changes: 5 additions & 5 deletions docs/pulumi-plugin/configure-provider.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Provider Configuration
title: Plugin Configuration
order: 1
---

# Provider Configuration
# Plugin Configuration

First, you need to enable the pulumi provider in your project configuration. This is as simple as placing it in your list of providers:
First, you need to enable the `pulumi` provider in your project configuration. This is as simple as placing it in your list of providers:
```yaml
apiVersion: garden.io/v1
kind: Project
Expand All @@ -18,9 +18,9 @@ providers:
In case you want to use different backends for different Garden environments you can configure your provider and deploy actions follows. This example uses two
different pulumi backends. In the `dev` environment it uses a self-managed state backend, in this case an S3 bucket which is specified
with the `backendURL`.
In the `prod` environment it uses pulumi managed state backend, which is the default so we don't need to specify a `backendURL`.
In the `prod` environment it uses pulumi managed state backend, which is the default so we don't need to specify a `backendURL`.

Note that when you use a self managed state backend, Garden's deploy action level `spec.cacheStatus` needs to be set to `false`, since
Note that when you use a self managed state backend, Garden's deploy action level `spec.cacheStatus` needs to be set to `false`, since
caching is only available with the pulumi managed state backend. The same applies to `spec.orgName` which only makes sense in the context of the pulumi managed state backend.
Please ensure that `spec.orgName` is set to `null` or empty string `""` for all the environments that are not using the pulumi managed state backend.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
order: 3
title: Deploy action Configuration
title: Action Configuration
---

# Deploy action Configuration
# Action Configuration

## Deploy Action

You can define `terraform` actions as part of your project, much like any other actions. A `terraform` action maps to a single `Deploy` that you can define as a runtime dependency for any of your other `Deploy`, `Run` and `Test` actions. You can also reference the stack outputs of a `terraform` action using [runtime output template strings](../using-garden/variables-and-templating.md#runtime-outputs). For example:

Expand Down
4 changes: 2 additions & 2 deletions docs/terraform-plugin/configure-provider.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
order: 2
title: Provider Configuration
title: Plugin Configuration
---

# Provider Configuration
# Plugin Configuration

First off, you need to enable the provider in your project configuration. This is as simple as placing it in your list of providers:

Expand Down

0 comments on commit 83efcf4

Please sign in to comment.