docs: adding terramate-block #62
Conversation
✅ Deploy Preview for docs-terramate-io ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
cli/projects/configuration.md
Outdated
| @@ -69,6 +69,7 @@ will occur. | |||
|
|
|||
| Project-wide configuration can be defined in this block. All possible settings are described in the following subsections. | |||
|
|
|||
| <a id="the-terramateconfiggit-block"></a> | |||
There was a problem hiding this comment.
Why are we adding those @AnnuCode ?
There was a problem hiding this comment.
because the heading includes an inline code, I had to add an anchor tag to link to that heading in another markdown file. Without this, the generated heading removed hyphens and couldn't link to the correct section.
There was a problem hiding this comment.
That's not correct ... e.g. the following link works and jumps directly to the right headline: https://terramate.io/docs/cli/reference/variables/metadata#stack-metadata
There was a problem hiding this comment.
e.g.
[foo](./terramate.md#the-terramate-block)should work.. the <a> element shouldn't be required at all. we don't use it anywhere
There was a problem hiding this comment.
you are right, I've corrected the section links. Thanks!
cli/projects/configuration.md
Outdated
| @@ -92,6 +93,7 @@ terramate { | |||
| } | |||
| ``` | |||
|
|
|||
| <a id="the-terramateconfiggenerate-block"></a> | |||
There was a problem hiding this comment.
Same here? we don't need this?
cli/reference/blocks/terramate.md
Outdated
| - `config.git`: [configure](../../projects/configuration.md#the-terramateconfiggit-block) git integration | ||
| - `config.generate`: [configure](../../projects/configuration.md#the-terramateconfiggenerate-block) code generation feature | ||
| - `config.run`: [configure](../../projects/configuration.md#the-terramateconfiggenerate-block) the `terramate run` command or set environment variables for it | ||
| - `config.cloud`: [configure](../../projects/configuration.md#the-terramateconfigcloud-block) the default Terramate Cloud organization name |
There was a problem hiding this comment.
Cloud is the block, the organization attribute is used to configure the Terramate Cloud Organization used in this project
cli/reference/blocks/terramate.md
Outdated
| run { | ||
| check_gen_code = false # Deprecated as of v0.4.5 (use terramate.config.disable_safeguards instead) | ||
| env { | ||
| TF_PLUGIN_CACHE_DIR = "/some/path/etc" |
There was a problem hiding this comment.
indentation seems off here
cli/reference/blocks/terramate.md
Outdated
| @@ -4,3 +4,46 @@ description: Learn how to configure a Terramate project using the terramate bloc | |||
| --- | |||
|
|
|||
| # The `terramate` block | |||
|
|
|||
| Use the `terramate` block to define project-wide configurations in the project's root. The `terramate` block is defined in the `terramate.tm.hcl` file and overrides any defaults by Terramate. | |||
There was a problem hiding this comment.
For correctness, the terramate block can be defined in any file in the root directory. Usually, we place it in the terramate.tm.hcl but it can have any name.
No description provided.