Chore: Generate docs for project-policies #161
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
omry-hay
reviewed
Nov 14, 2021
docs/data-sources/project_policy.md
Outdated
|
|
||
| ### Read-Only | ||
|
|
||
| - **disable_destroy_environments** (Boolean) disable destroy environments |
There was a problem hiding this comment.
Suggested change
| - **disable_destroy_environments** (Boolean) disable destroy environments | |
| - **disable_destroy_environments** (Boolean) Disallow destroying environment in the project |
| ### Read-Only | ||
|
|
||
| - **disable_destroy_environments** (Boolean) disable destroy environments | ||
| - **id** (String) id of the policy |
There was a problem hiding this comment.
Can we make this the first item in this section?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
So forget about it, it's not really important.
docs/data-sources/project_policy.md
Outdated
|
|
||
| - **disable_destroy_environments** (Boolean) disable destroy environments | ||
| - **id** (String) id of the policy | ||
| - **include_cost_estimation** (Boolean) include cost estimation |
There was a problem hiding this comment.
Suggested change
| - **include_cost_estimation** (Boolean) include cost estimation | |
| - **include_cost_estimation** (Boolean) Enable cost estimation for the project |
docs/data-sources/project_policy.md
Outdated
| - **disable_destroy_environments** (Boolean) disable destroy environments | ||
| - **id** (String) id of the policy | ||
| - **include_cost_estimation** (Boolean) include cost estimation | ||
| - **number_of_environments** (Number) number of environments per project |
There was a problem hiding this comment.
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 |
docs/data-sources/project_policy.md
Outdated
| - **id** (String) id of the policy | ||
| - **include_cost_estimation** (Boolean) include cost estimation | ||
| - **number_of_environments** (Number) number of environments per project | ||
| - **number_of_environments_total** (Number) number of environments total |
There was a problem hiding this comment.
Suggested change
| - **number_of_environments_total** (Number) number of environments total | |
| - **number_of_environments_total** (Number) Max number of environments in this project |
docs/data-sources/project_policy.md
Outdated
| - **include_cost_estimation** (Boolean) include cost estimation | ||
| - **number_of_environments** (Number) number of environments per project | ||
| - **number_of_environments_total** (Number) number of environments total | ||
| - **requires_approval_default** (Boolean) requires approval |
There was a problem hiding this comment.
Suggested change
| - **requires_approval_default** (Boolean) requires approval | |
| - **requires_approval_default** (Boolean) Requires approval default value when creating a new environment in the project |
docs/data-sources/project_policy.md
Outdated
| - **number_of_environments** (Number) number of environments per project | ||
| - **number_of_environments_total** (Number) number of environments total | ||
| - **requires_approval_default** (Boolean) requires approval | ||
| - **skip_apply_when_plan_is_empty** (Boolean) skip apply when plan is empty |
There was a problem hiding this comment.
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 |
docs/data-sources/project_policy.md
Outdated
| - **number_of_environments_total** (Number) number of environments total | ||
| - **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 |
There was a problem hiding this comment.
Suggested change
| - **skip_redundant_deployments** (Boolean) skip redundant deployments | |
| - **skip_redundant_deployments** (Boolean) Automatically skip queued deployments when a newer deployment is triggered |
docs/resources/project_policy.md
Outdated
Comment on lines
24
to
30
| - **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 |
There was a problem hiding this comment.
Same as the above.
In the number_of_environments and number_of_environments_total please also add 0 indicates no limit
omry-hay
approved these changes
Nov 14, 2021
| ### Read-Only | ||
|
|
||
| - **disable_destroy_environments** (Boolean) disable destroy environments | ||
| - **id** (String) id of the policy |
There was a problem hiding this comment.
So forget about it, it's not really important.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue & Steps to Reproduce / Feature Request
Generated docs for project-policies before release #151