Skip to content

Commit 866dfa9

Browse files
authored
docs: Misc documentation fixes (#133)
## What * Misc doc fixes. ## Why ## Notes <!-- Add any notes here --> ## Checklist * [x] _I have read [CONTRIBUTING.md](https://github.com/codefresh-io/terraform-provider-codefresh/blob/master/CONTRIBUTING.md)._ * [x] _I have [allowed changes to my fork to be made](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork)._ * [x] _I have added tests, assuming new tests are warranted_. * [x] _I understand that the `/test` comment will be ignored by the CI trigger [unless it is made by a repo admin or collaborator](https://codefresh.io/docs/docs/pipelines/triggers/git-triggers/#support-for-building-pull-requests-from-forks)._
1 parent 00721ed commit 866dfa9

12 files changed

+55
-53
lines changed

codefresh/resource_abac_rules.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ var validSetValues = []string{"REFRESH", "SYNC", "TERMINATE_SYNC", "VIEW_POD_LOG
1515

1616
func resourceGitopsAbacRule() *schema.Resource {
1717
return &schema.Resource{
18-
Description: "Gitops Abac Rules are used to setup access control and allow to define which teams have access to which resources based on tags and attributes.",
18+
Description: "Gitops ABAC Rules are used to setup access control and allow to define which teams have access to which resources based on tags and attributes.",
1919
Create: resourceGitopsAbacRuleCreate,
2020
Read: resourceGitopsAbacRuleRead,
2121
Update: resourceGitopsAbacRuleUpdate,
@@ -32,7 +32,7 @@ func resourceGitopsAbacRule() *schema.Resource {
3232
},
3333
"entity_type": {
3434
Description: `
35-
The type of resources the abac rules applies to. Possible values:
35+
The type of resources the ABAC rules applies to. Possible values:
3636
* gitopsApplications
3737
`,
3838
Type: schema.TypeString,
@@ -42,16 +42,16 @@ The type of resources the abac rules applies to. Possible values:
4242
}, false),
4343
},
4444
"teams": {
45-
Description: "The Ids of teams the abac rules apply to.",
45+
Description: "The IDs of the teams the ABAC rules apply to.",
4646
Type: schema.TypeSet,
4747
Required: true,
4848
Elem: &schema.Schema{Type: schema.TypeString},
4949
},
5050
"tags": {
5151
Description: `
52-
The effective tags to apply the permission. It supports 2 custom tags:
53-
* untagged is a “tag” which refers to all resources that don't have any tag.
54-
* (the star character) means all tags.
52+
The effective tags of the resource to apply the permission to. There are two special tags:
53+
* untagged: Apply to all resources without tags.
54+
* * (asterisk): Apply to all resources with any tag.
5555
`,
5656
Type: schema.TypeSet,
5757
Optional: true,

codefresh/resource_account.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ func resourceAccount() *schema.Resource {
2727
Description: `
2828
Features toggles for this account. Default:
2929
30-
OfflineLogging: true
31-
ssoManagement: true
32-
teamsManagement: true
33-
abac: true
34-
customKubernetesCluster: true
30+
* OfflineLogging: true
31+
* ssoManagement: true
32+
* teamsManagement: true
33+
* abac: true
34+
* customKubernetesCluster: true
3535
`,
3636
Type: schema.TypeMap,
3737
Optional: true,
@@ -58,7 +58,7 @@ customKubernetesCluster: true
5858
Required: true,
5959
},
6060
"data_retention_weeks": {
61-
Description: "Specifies how long, in weeks, the builds be stored (default: `5`).",
61+
Description: "Specifies the number of weeks for which to store the builds (default: `5`).",
6262
Type: schema.TypeInt,
6363
Optional: true,
6464
Default: 5,

codefresh/resource_account_admins.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ func resourceAccountAdmins() *schema.Resource {
2020
},
2121
Schema: map[string]*schema.Schema{
2222
"account_id": {
23-
Description: "The account id where to set up a list of admins.",
23+
Description: "The account ID for which to set up the list of admins.",
2424
Type: schema.TypeString,
2525
Required: true,
2626
},

codefresh/resource_context.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ func getConflictingContexts(context string) []string {
4242

4343
func resourceContext() *schema.Resource {
4444
return &schema.Resource{
45-
Description: "A Context is an authentication/configuration that is used by the Codefresh system and engine.",
45+
Description: "A Context is an authentication/configuration resource used by the Codefresh system and engine.",
4646
Create: resourceContextCreate,
4747
Read: resourceContextRead,
4848
Update: resourceContextUpdate,

codefresh/resource_permission.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import (
1414

1515
func resourcePermission() *schema.Resource {
1616
return &schema.Resource{
17-
Description: "Permission are used to setup access control and allow to define which teams have access to which clusters and pipelines based on tags.",
17+
Description: "Permissions are used to set up access control and define which teams have access to which clusters and pipelines based on tags.",
1818
Create: resourcePermissionCreate,
1919
Read: resourcePermissionRead,
2020
Update: resourcePermissionUpdate,
@@ -85,9 +85,9 @@ Action to be allowed. Possible values:
8585
},
8686
"tags": {
8787
Description: `
88-
The effective tags to apply the permission. It supports 2 custom tags:
89-
* untagged is a “tag” which refers to all clusters that don't have any tag.
90-
* (the star character) means all tags.
88+
The tags for which to apply the permission. Supports two custom tags:
89+
* untagged: Apply to all resources without tags
90+
* (asterisk): Apply to all resources with any tag
9191
`,
9292
Type: schema.TypeSet,
9393
Optional: true,

docs/resources/abac_rules.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
page_title: "codefresh_abac_rules Resource - terraform-provider-codefresh"
33
subcategory: ""
44
description: |-
5-
Gitops Abac Rules are used to setup access control and allow to define which teams have access to which resources based on tags and attributes.
5+
Gitops ABAC Rules are used to setup access control and allow to define which teams have access to which resources based on tags and attributes.
66
---
77

88
# codefresh_abac_rules (Resource)
99

10-
Gitops Abac Rules are used to setup access control and allow to define which teams have access to which resources based on tags and attributes.
10+
Gitops ABAC Rules are used to setup access control and allow to define which teams have access to which resources based on tags and attributes.
1111

12-
See the [Access Control documentation](https://codefresh.io/docs/docs/administration/account-user-management/access-control/).
12+
See the [GitOps Access Control documentation](https://codefresh.io/docs/docs/administration/account-user-management/gitops-abac/).
1313

1414
## Example usage
1515

@@ -48,17 +48,17 @@ resource "codefresh_abac_rules" "app_rule" {
4848
* TERMINATE_SYNC
4949
* VIEW_POD_LOGS
5050
* APP_ROLLBACK
51-
- `entity_type` (String) The type of resources the abac rules applies to. Possible values:
51+
- `entity_type` (String) The type of resources the ABAC rules applies to. Possible values:
5252
* gitopsApplications
53-
- `teams` (Set of String) The Ids of teams the abac rules apply to.
53+
- `teams` (Set of String) The IDs of the teams the ABAC rules apply to.
5454

5555
### Optional
5656

5757
- `attribute` (Block List) Resource attribute that need to be validated (see [below for nested schema](#nestedblock--attribute))
5858
- `id` (String) The abac rule ID.
59-
- `tags` (Set of String) The effective tags to apply the permission. It supports 2 custom tags:
60-
* untagged is a “tag” which refers to all resources that don't have any tag.
61-
* (the star character) means all tags.
59+
- `tags` (Set of String) The effective tags of the resource to apply the permission to. There are two special tags:
60+
* untagged: Apply to all resources without tags.
61+
* * (asterisk): Apply to all resources with any tag.
6262

6363
<a id="nestedblock--attribute"></a>
6464
### Nested Schema for `attribute`
@@ -70,4 +70,4 @@ Required:
7070

7171
Optional:
7272

73-
- `key` (String)
73+
- `key` (String)

docs/resources/account.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@ resource "codefresh_account" "test" {
4949
- `build` (Block List) Build limits for this account. (see [below for nested schema](#nestedblock--build))
5050
- `features` (Map of Boolean) Features toggles for this account. Default:
5151

52-
OfflineLogging: true
53-
ssoManagement: true
54-
teamsManagement: true
55-
abac: true
56-
customKubernetesCluster: true
52+
* OfflineLogging: true
53+
* ssoManagement: true
54+
* teamsManagement: true
55+
* abac: true
56+
* customKubernetesCluster: true
5757
- `limits` (Block List) Limits for this account. (see [below for nested schema](#nestedblock--limits))
5858

5959
### Read-Only
@@ -81,7 +81,7 @@ Required:
8181

8282
Optional:
8383

84-
- `data_retention_weeks` (Number) Specifies how long, in weeks, the builds be stored (default: `5`).
84+
- `data_retention_weeks` (Number) Specifies the number of weeks for which to store the builds (default: `5`).
8585

8686
## Import
8787
```sh

docs/resources/account_admins.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ resource "codefresh_account_admins" "test" {
6161

6262
### Required
6363

64-
- `account_id` (String) The account id where to set up a list of admins.
64+
- `account_id` (String) The account ID for which to set up the list of admins.
6565
- `users` (Set of String) A list of users to set up as account admins.
6666

6767
### Read-Only

docs/resources/context.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,22 @@
22
page_title: "codefresh_context Resource - terraform-provider-codefresh"
33
subcategory: ""
44
description: |-
5-
A Context is an authentication/configuration that is used by the Codefresh system and engine.
5+
A Context is an authentication/configuration resource used by the Codefresh system and engine.
66
---
77

88
# codefresh_context (Resource)
99

10-
A Context is an authentication/configuration that is used by the Codefresh system and engine.
10+
A Context is an authentication/configuration resource used by the Codefresh system and engine.
1111

1212
## Supported types
1313

14-
There are multiple types of context available in Codefresh but they all have the following main components to define them:
14+
Codefresh supports multiple types of Contexts, all of which share the following components:
1515

1616
* `Name`: A unique identifier for the context
1717
* `Type`: A string representing the type of context
18-
* `Data`: A data structure that provide the information related to the Context. This differs based on the type of context selected
19-
For more details of the Context spec see in the [CLI official documentation](https://codefresh-io.github.io/cli/contexts/spec/)
18+
* `Data`: A data structure that provides the information related to the Context. This differs based on the type of Context selected.
19+
20+
For more details of the Context spec, please refer to the [official Codefresh CLI documentation](https://codefresh-io.github.io/cli/contexts/spec/)
2021

2122
Currently the provider supports the following types of Context:
2223

@@ -26,7 +27,7 @@ Currently the provider supports the following types of Context:
2627
* `secret-yaml` (Secret YAML Configuration Context)
2728

2829
### Shared Configuration
29-
A Shared Configuration is the entity in Codefresh that allow to create values in a central place that can then be consumed in pipelines to keep them DRY.
30+
A Shared Configuration is the entity in Codefresh where you can create values in a centralized location, and then consume in pipelines to keep them [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself).
3031
More details in the official [Shared Configuration documentation](https://codefresh.io/docs/docs/configure-ci-cd-pipeline/shared-configuration/)
3132

3233
### Example Usage
@@ -225,4 +226,4 @@ Required:
225226

226227
Required:
227228

228-
- `data` (String) The YAML string representing the shared config.
229+
- `data` (String) The YAML string representing the shared config.

docs/resources/permission.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
page_title: "codefresh_permission Resource - terraform-provider-codefresh"
33
subcategory: ""
44
description: |-
5-
Permission are used to setup access control and allow to define which teams have access to which clusters and pipelines based on tags.
5+
Permissions are used to set up access control and define which teams have access to which clusters and pipelines based on tags.
66
---
77

88
# codefresh_permission (Resource)
99

10-
Permission are used to setup access control and allow to define which teams have access to which clusters and pipelines based on tags.
10+
Permissions are used to set up access control and define which teams have access to which clusters and pipelines based on tags.
1111

1212
See the [Access Control documentation](https://codefresh.io/docs/docs/administration/account-user-management/access-control/).
1313

@@ -59,9 +59,9 @@ resource "codefresh_permission" "developers" {
5959
- `_id` (String) The permission ID.
6060
- `related_resource` (String) Specifies the resource to use when evaluating the tags. Possible values:
6161
* project
62-
- `tags` (Set of String) The effective tags to apply the permission. It supports 2 custom tags:
63-
* untagged is a “tag” which refers to all clusters that don't have any tag.
64-
* (the star character) means all tags.
62+
- `tags` (Set of String) The tags for which to apply the permission. Supports two custom tags:
63+
* untagged: Apply to all resources without tags
64+
* (asterisk): Apply to all resources with any tag
6565

6666
### Read-Only
6767

templates/resources/abac_rules.md.tmpl

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: |-
99

1010
{{ .Description | trimspace }}
1111

12-
See the [Access Control documentation](https://codefresh.io/docs/docs/administration/account-user-management/access-control/).
12+
See the [GitOps Access Control documentation](https://codefresh.io/docs/docs/administration/account-user-management/gitops-abac/).
1313

1414
## Example usage
1515

@@ -37,4 +37,4 @@ resource "codefresh_abac_rules" "app_rule" {
3737

3838
```
3939

40-
{{ .SchemaMarkdown | trimspace }}
40+
{{ .SchemaMarkdown | trimspace }}

templates/resources/context.md.tmpl

+6-5
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,13 @@ description: |-
1111

1212
## Supported types
1313

14-
There are multiple types of context available in Codefresh but they all have the following main components to define them:
14+
Codefresh supports multiple types of Contexts, all of which share the following components:
1515

1616
* `Name`: A unique identifier for the context
1717
* `Type`: A string representing the type of context
18-
* `Data`: A data structure that provide the information related to the Context. This differs based on the type of context selected
19-
For more details of the Context spec see in the [CLI official documentation](https://codefresh-io.github.io/cli/contexts/spec/)
18+
* `Data`: A data structure that provides the information related to the Context. This differs based on the type of Context selected.
19+
20+
For more details of the Context spec, please refer to the [official Codefresh CLI documentation](https://codefresh-io.github.io/cli/contexts/spec/)
2021

2122
Currently the provider supports the following types of Context:
2223

@@ -26,7 +27,7 @@ Currently the provider supports the following types of Context:
2627
* `secret-yaml` (Secret YAML Configuration Context)
2728

2829
### Shared Configuration
29-
A Shared Configuration is the entity in Codefresh that allow to create values in a central place that can then be consumed in pipelines to keep them DRY.
30+
A Shared Configuration is the entity in Codefresh where you can create values in a centralized location, and then consume in pipelines to keep them [DRY](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself).
3031
More details in the official [Shared Configuration documentation](https://codefresh.io/docs/docs/configure-ci-cd-pipeline/shared-configuration/)
3132

3233
### Example Usage
@@ -95,4 +96,4 @@ resource "codefresh_context" "test-secret-yaml" {
9596
}
9697
```
9798

98-
{{ .SchemaMarkdown | trimspace }}
99+
{{ .SchemaMarkdown | trimspace }}

0 commit comments

Comments
 (0)