Skip to content

Commit 07f85af

Browse files
tenekoteneko
committed
docs: updated README.md
1 parent 92a974f commit 07f85af

File tree

4 files changed

+23
-18
lines changed

4 files changed

+23
-18
lines changed

‎README.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1-
# terraform-provider-value
1+
# Value Provider for Terraform [![latest release tag](https://img.shields.io/github/v/tag/pseudo-dynamic/terraform-provider-value?label=release)](https://github.com/pseudo-dynamic/terraform-provider-value/releases) [![license](https://img.shields.io/github/license/hashicorp/terraform-provider-kubernetes.svg)](./LICENSE)
22

3-
A terraform provider providing resources to work with values. :smile:
3+
A terraform provider providing resources to work with values. :smile:
4+
5+
- [Documentation](./docs/)
6+
- [Resources](./docs/resources/)
7+
- [Data Sources](./docs/data-sources/)
8+
- [Examples](./examples/)

‎docs/resources/is_fully_known.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subcategory: ""
55
description: |-
66
Allows you to have a access to result during plan phase that states whether value or any nested attribute is marked as "(known after apply)" or not.
77
Provider Metadata
8-
Each module can use provider_meta. Beware that these settings only count for resources of this module. (see https://www.terraform.io/internals/provider-meta):
8+
Each module can use provider_meta. Please keep in mind that these settings only count for resources of this module! (see https://www.terraform.io/internals/provider-meta):
99
terraform
1010
// Terraform provider_meta example
1111
terraform {
@@ -20,16 +20,16 @@ description: |-
2020
seed_prefix (String) It gets appended to each seed of any value_is_fully_known (resource) or value_is_known (resource) within the same module.
2121
Placeholders:
2222
"{workdir}" (Keyword) The actual workdir; equals to terraform's path.root. This placeholder is
23-
recommended because this value won't be drag along the plan and apply phase in comparison to
24-
abspath(path.root) that you would add to resource seed where a change to path.root would be
23+
recommended because this value won't be dragged along the plan and apply phase in comparison to
24+
"abspath(path.root)" that you would add to resource seed where a change to path.root would be
2525
recognized just as usual from terraform.
2626
---
2727

2828
# value_is_fully_known (Resource)
2929

3030
Allows you to have a access to `result` during plan phase that states whether `value` or any nested attribute is marked as "(known after apply)" or not.
3131
## Provider Metadata
32-
Each module can use provider_meta. Beware that these settings only count for resources of this module. (see https://www.terraform.io/internals/provider-meta):
32+
Each module can use provider_meta. Please keep in mind that these settings only count for resources of this module! (see https://www.terraform.io/internals/provider-meta):
3333
```terraform
3434
// Terraform provider_meta example
3535
terraform {
@@ -45,8 +45,8 @@ terraform {
4545

4646
**Placeholders**:
4747
- "{workdir}" (Keyword) The actual workdir; equals to terraform's path.root. This placeholder is
48-
recommended because this value won't be drag along the plan and apply phase in comparison to
49-
abspath(path.root) that you would add to resource seed where a change to path.root would be
48+
recommended because this value won't be dragged along the plan and apply phase in comparison to
49+
"abspath(path.root)" that you would add to resource seed where a change to path.root would be
5050
recognized just as usual from terraform.
5151

5252

‎docs/resources/is_known.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subcategory: ""
55
description: |-
66
Allows you to have a access to result during plan phase that states whether value marked as "(known after apply)" or not.
77
Provider Metadata
8-
Each module can use provider_meta. Beware that these settings only count for resources of this module. (see https://www.terraform.io/internals/provider-meta):
8+
Each module can use provider_meta. Please keep in mind that these settings only count for resources of this module! (see https://www.terraform.io/internals/provider-meta):
99
terraform
1010
// Terraform provider_meta example
1111
terraform {
@@ -20,16 +20,16 @@ description: |-
2020
seed_prefix (String) It gets appended to each seed of any value_is_fully_known (resource) or value_is_known (resource) within the same module.
2121
Placeholders:
2222
"{workdir}" (Keyword) The actual workdir; equals to terraform's path.root. This placeholder is
23-
recommended because this value won't be drag along the plan and apply phase in comparison to
24-
abspath(path.root) that you would add to resource seed where a change to path.root would be
23+
recommended because this value won't be dragged along the plan and apply phase in comparison to
24+
"abspath(path.root)" that you would add to resource seed where a change to path.root would be
2525
recognized just as usual from terraform.
2626
---
2727

2828
# value_is_known (Resource)
2929

3030
Allows you to have a access to `result` during plan phase that states whether `value` marked as "(known after apply)" or not.
3131
## Provider Metadata
32-
Each module can use provider_meta. Beware that these settings only count for resources of this module. (see https://www.terraform.io/internals/provider-meta):
32+
Each module can use provider_meta. Please keep in mind that these settings only count for resources of this module! (see https://www.terraform.io/internals/provider-meta):
3333
```terraform
3434
// Terraform provider_meta example
3535
terraform {
@@ -45,8 +45,8 @@ terraform {
4545

4646
**Placeholders**:
4747
- "{workdir}" (Keyword) The actual workdir; equals to terraform's path.root. This placeholder is
48-
recommended because this value won't be drag along the plan and apply phase in comparison to
49-
abspath(path.root) that you would add to resource seed where a change to path.root would be
48+
recommended because this value won't be dragged along the plan and apply phase in comparison to
49+
"abspath(path.root)" that you would add to resource seed where a change to path.root would be
5050
recognized just as usual from terraform.
5151

5252

‎isknown/common/provider_meta_schema.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ func getObjectTypeFromSchema(schema *tfprotov6.Schema) tftypes.Type {
4949
}
5050

5151
var seedPrefixDescription = "## Provider Metadata\n" +
52-
"Each module can use provider_meta. Beware that these settings only count " +
53-
"for resources of this module. (see https://www.terraform.io/internals/provider-meta):\n" +
52+
"Each module can use provider_meta. Please keep in mind that these settings only count " +
53+
"for resources of this module! (see https://www.terraform.io/internals/provider-meta):\n" +
5454
"```terraform\n" + `// Terraform provider_meta example
5555
terraform {
5656
// "value" is the provider name
@@ -64,8 +64,8 @@ terraform {
6464
"`value_is_known` (resource) within the same module.\n" + `
6565
**Placeholders**:
6666
- "{workdir}" (Keyword) The actual workdir; equals to terraform's path.root. This placeholder is
67-
recommended because this value won't be drag along the plan and apply phase in comparison to
68-
abspath(path.root) that you would add to resource seed where a change to path.root would be
67+
recommended because this value won't be dragged along the plan and apply phase in comparison to
68+
"abspath(path.root)" that you would add to resource seed where a change to path.root would be
6969
recognized just as usual from terraform.`
7070

7171
func GetProviderMetaSchema() *tfprotov6.Schema {

0 commit comments

Comments
 (0)