Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chore: Generate docs for project-policies #161

Merged
merged 9 commits into from
Nov 14, 2021
34 changes: 34 additions & 0 deletions docs/data-sources/project_policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "env0_project_policy Data Source - terraform-provider-env0"
subcategory: ""
description: |-

---

# env0_project_policy (Data Source)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **project_id** (String) id of the project

### Read-Only

- **disable_destroy_environments** (Boolean) disable destroy environments
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **disable_destroy_environments** (Boolean) disable destroy environments
- **disable_destroy_environments** (Boolean) Disallow destroying environment in the project

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- **id** (String) id of the policy
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make this the first item in this section?

Copy link
Contributor Author

@liranfarage89 liranfarage89 Nov 14, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can change it manually, but the next time we run generateDocs it will change it back. Seems like it arranges it alphabetically. Couldn't find any flag/config in the plugin repo

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So forget about it, it's not really important.

- **include_cost_estimation** (Boolean) include cost estimation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **include_cost_estimation** (Boolean) include cost estimation
- **include_cost_estimation** (Boolean) Enable cost estimation for the project

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- **number_of_environments** (Number) number of environments per project
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **number_of_environments** (Number) number of environments per project
- **number_of_environments** (Number) Max number of environment a single user can have in this project

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- **number_of_environments_total** (Number) number of environments total
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **number_of_environments_total** (Number) number of environments total
- **number_of_environments_total** (Number) Max number of environments in this project

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- **requires_approval_default** (Boolean) requires approval
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **requires_approval_default** (Boolean) requires approval
- **requires_approval_default** (Boolean) Requires approval default value when creating a new environment in the project

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- **skip_apply_when_plan_is_empty** (Boolean) skip apply when plan is empty
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **skip_apply_when_plan_is_empty** (Boolean) skip apply when plan is empty
- **skip_apply_when_plan_is_empty** (Boolean) Skip apply when plan has no changes

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- **skip_redundant_deployments** (Boolean) skip redundant deployments
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- **skip_redundant_deployments** (Boolean) skip redundant deployments
- **skip_redundant_deployments** (Boolean) Automatically skip queued deployments when a newer deployment is triggered

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- **updated_by** (String) updated by


37 changes: 37 additions & 0 deletions docs/resources/project_policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "env0_project_policy Resource - terraform-provider-env0"
subcategory: ""
description: |-

---

# env0_project_policy (Resource)





<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **project_id** (String) id of the project

### Optional

- **disable_destroy_environments** (Boolean) disable destroy environments
- **include_cost_estimation** (Boolean) include cost estimation
- **number_of_environments** (Number) number of environments per project, 0 indicates no limit
- **number_of_environments_total** (Number) number of environments total, 0 indicates no limit
- **requires_approval_default** (Boolean) requires approval
- **skip_apply_when_plan_is_empty** (Boolean) skip apply when plan is empty
- **skip_redundant_deployments** (Boolean) skip redundant deployments
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as the above.
In the number_of_environments and number_of_environments_total please also add 0 indicates no limit

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


### Read-Only

- **id** (String) id of the policy
- **updated_by** (String) updated by