Skip to content

docs: Reworked existing policy examples to use PlaygroundExample #7690

Merged
charlieegan3 merged 6 commits intoopen-policy-agent:mainfrom
sky3n3t:main
Jun 12, 2025
Merged

docs: Reworked existing policy examples to use PlaygroundExample #7690
charlieegan3 merged 6 commits intoopen-policy-agent:mainfrom
sky3n3t:main

Conversation

@sky3n3t
Copy link
Copy Markdown
Contributor

@sky3n3t sky3n3t commented Jun 11, 2025

Why the changes in this PR are needed?

To standardise examples and allow for snippets to be passed through PlaygroundExample

What are the changes in this PR?

It changes the remaining examples in Policy Reference to use PlaygroundExample instead of RunSnippet as well as allows the user to pass predefined snippets through PlaygroundExample

Comment thread docs/docs/policy-reference/_examples/graphs/reachable/data.json
Comment thread docs/docs/policy-reference/_examples/rego/example/policy.rego
Comment thread docs/docs/policy-reference/_examples/tokens/sign/jwt2/config.json
Copy link
Copy Markdown
Contributor

@charlieegan3 charlieegan3 left a comment

Choose a reason for hiding this comment

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

Thanks for all this work @sky3n3t, it's a big one but really easy to follow. Few little suggestions to help improve the component and to reduce the number of files needed for future but then we're good to go here too.

@netlify
Copy link
Copy Markdown

netlify Bot commented Jun 11, 2025

Deploy Preview for openpolicyagent ready!

Name Link
🔨 Latest commit
🔍 Latest deploy log https://app.netlify.com/projects/openpolicyagent/deploys/68498e740abc346d9a0a7d11
😎 Deploy Preview https://deploy-preview-7690--openpolicyagent.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link
Copy Markdown

netlify Bot commented Jun 11, 2025

Deploy Preview for openpolicyagent ready!

Name Link
🔨 Latest commit 80e0a97
🔍 Latest deploy log https://app.netlify.com/projects/openpolicyagent/deploys/684a936b70e4e100087bc253
😎 Deploy Preview https://deploy-preview-7690--openpolicyagent.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Comment thread docs/src/components/PlaygroundExample/index.js Outdated
Copy link
Copy Markdown
Contributor

@charlieegan3 charlieegan3 left a comment

Choose a reason for hiding this comment

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

LGTM!

sky3n3t added 4 commits June 12, 2025 08:33
…ional field to the component

Signed-off-by: Telumiel <skye@skyenet.app>
…e structure

Signed-off-by: Telumiel <skye@skyenet.app>
Signed-off-by: Telumiel <skye@skyenet.app>

Update index.md

Signed-off-by: Telumiel <skye@skyenet.app>

Finally working
Signed-off-by: Telumiel <skye@skyenet.app>
Signed-off-by: Telumiel <skye@skyenet.app>
Signed-off-by: Telumiel <skye@skyenet.app>
@charlieegan3 charlieegan3 merged commit ddf6a3b into open-policy-agent:main Jun 12, 2025
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants