Update workspace FAQ and policy values concepts with control/policy creation information #390
Conversation
…reation updates from materialization
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsupdate-faq-materialization-turbot.vercel.app |
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation to clarify when policies and controls are created in Guardrails, distinguishing between configuration policies (created automatically) and control-specific policies (created only when settings exist).
- Adds comprehensive FAQ section covering policy value creation, control instance creation, and related concepts
- Updates existing documentation to reflect that policy values are only created when policy settings exist
- Improves clarity around the distinction between having no policy value versus having a policy set to "Skip"
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
docs/faq/workspace-faq/index.md |
Adds 6 new FAQ entries explaining policy value creation, control instance creation, and browsing available types |
docs/concepts/policies/values-settings.md |
Updates policy values example to clarify they only exist when policy settings are configured |
docs/getting-started/7-minute-labs/set-policy/index.md |
Minor formatting improvements to step numbering and text flow |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]>
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsupdate-faq-materialization-turbot.vercel.app |
…ails-docs into update-faq-materialization
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsupdate-faq-materialization-turbot.vercel.app |
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsupdate-faq-materialization-turbot.vercel.app |
…faq-materialization
…and policy values concepts doc
docs/concepts/controls/index.md
Outdated
| Control creation is controlled by the `Turbot > Materialization` policy, which supports two modes: | ||
|
|
||
| - **Always**: Controls are created for all resources regardless of whether policy settings exist. This provides comprehensive coverage but may impact performance in large environments. | ||
| - **Automatic**: Controls are only created when you explicitly set a policy setting for the primary policy that drives that control somewhere in the resource hierarchy. For example, the `AWS > S3 > Bucket > Approved` control will only appear on your S3 buckets when you have a policy setting for the `AWS > S3 > Bucket > Approved` policy type. However, if you only create policy settings for its sub-policies, like `AWS > S3 > Bucket > Approved > Regions`, the control will **not** be created. |
There was a problem hiding this comment.
From:
Controls are only created when you explicitly set a policy setting for the primary policy that drives that control somewhere in the resource hierarchy
To:
Controls are only created when you explicitly set the primary policy in the resource hierarchy
| Policy value creation is controlled by the `Turbot > Materialization` policy, which supports two modes: | ||
|
|
||
| - **Always**: Policy values are created for all resources regardless of whether policy settings exist. This provides comprehensive coverage but may impact performance in large environments. | ||
| - **Automatic**: Policy values are only created when you explicitly set a policy setting somewhere in the resource hierarchy. For example, if no policy setting exists for `AWS > S3 > Bucket > Approved` at the AWS account level, then S3 buckets in that account will not have policy values for `AWS > S3 > Bucket > Approved` or its sub-policies. |
There was a problem hiding this comment.
Old:
Policy values are only created when you explicitly set a policy setting somewhere in the resource hierarchy
New:
Primary policy values are only created when you explicitly set a primary policy in the resource hierarchy. For sub policy types, their values are also created when a related primary policy setting is created.
Clarified the description of the 'Automatic' control creation mode in the documentation.
Clarified the description of the 'Automatic' policy value creation mode, specifying the behavior for primary and sub-policy types.
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsupdate-faq-materialization-turbot.vercel.app |
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]>
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsupdate-faq-materialization-turbot.vercel.app |
Preview Available 🚀Commit Author: Karan Popat Preview Link: turbot-com-git-docs-guardrailsupdate-faq-materialization-turbot.vercel.app |
No description provided.