Skip to content

docs: Move code example data inside the PlaygroundComponent#7724

Merged
charlieegan3 merged 2 commits intoopen-policy-agent:mainfrom
sky3n3t:PlaygroundMigration
Jun 25, 2025
Merged

docs: Move code example data inside the PlaygroundComponent#7724
charlieegan3 merged 2 commits intoopen-policy-agent:mainfrom
sky3n3t:PlaygroundMigration

Conversation

@sky3n3t
Copy link
Copy Markdown
Contributor

@sky3n3t sky3n3t commented Jun 24, 2025

Why the changes in this PR are needed?

These changes makes it easier to use an example in multiple places since the explanations and titles have been moved inside the component using the already existing intro and title attributes.

What are the changes in this PR?

Restructuring of the policy ref docs and adding collapsible playground examples that are currently disabled

Related to #7684

@netlify
Copy link
Copy Markdown

netlify Bot commented Jun 24, 2025

Deploy Preview for openpolicyagent ready!

Name Link
🔨 Latest commit c4afe02
🔍 Latest deploy log https://app.netlify.com/projects/openpolicyagent/deploys/685bf18f05105a00087d29e7
😎 Deploy Preview https://deploy-preview-7724--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
@sky3n3t sky3n3t force-pushed the PlaygroundMigration branch 2 times, most recently from 8379c76 to ac8df46 Compare June 24, 2025 15:45
Comment thread docs/src/components/PlaygroundExample/styles.module.css 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.

This is looking great, having all the example text in the example config dirs makes it easier for us to show them off in more interesting ways. We're nearly there on the styles here. I like how it it looks, just some minor bugs to iron out.

@sky3n3t sky3n3t force-pushed the PlaygroundMigration branch from ac8df46 to 95c3fac Compare June 24, 2025 15:54
Comment thread docs/src/components/PlaygroundExample/index.js
Comment thread docs/docs/policy-reference/_examples/graphs/reachable/config.json Outdated
@sky3n3t sky3n3t force-pushed the PlaygroundMigration branch 2 times, most recently from 2be008c to 534a98a Compare June 25, 2025 09:29
Comment thread docs/src/components/PlaygroundExample/index.js Outdated
Comment thread docs/src/components/PlaygroundExample/index.js Outdated
Comment thread docs/src/components/PlaygroundExample/index.js Outdated
@sky3n3t sky3n3t force-pushed the PlaygroundMigration branch 2 times, most recently from 470286e to 92f18f1 Compare June 25, 2025 12:26
Comment thread docs/src/components/PlaygroundExample/index.js Outdated
Comment thread docs/src/components/PlaygroundExample/index.js
@sky3n3t sky3n3t force-pushed the PlaygroundMigration branch from 92f18f1 to e94bd8d Compare June 25, 2025 12:31
Comment thread docs/docs/policy-reference/_examples/net/cidr_contains_strings/title.txt Outdated
Comment thread docs/docs/policy-reference/_examples/net/cidr_contains_objects/title.txt Outdated
Comment thread docs/docs/policy-reference/_examples/net/cidr_contains_arrays/title.txt Outdated
Comment thread docs/docs/policy-reference/_examples/net/cidr_contains_array_string/title.txt Outdated
Comment thread docs/src/components/PlaygroundExample/index.js Outdated
@sky3n3t sky3n3t force-pushed the PlaygroundMigration branch from e3b74f9 to 90bdaf3 Compare June 25, 2025 12:41
Comment thread docs/docs/policy-reference/index.md Outdated
Comment thread docs/docs/policy-reference/_examples/rego/rule_metadata/title.txt Outdated
Comment thread docs/docs/policy-reference/_examples/time/time_format/title.txt Outdated
@sky3n3t sky3n3t force-pushed the PlaygroundMigration branch 2 times, most recently from ebefa52 to a95eebc Compare June 25, 2025 12:44
sky3n3t added 2 commits June 25, 2025 14:54
Signed-off-by: Telumiel <skye@skyenet.app>
Signed-off-by: Telumiel <skye@skyenet.app>
@sky3n3t sky3n3t force-pushed the PlaygroundMigration branch from a95eebc to c4afe02 Compare June 25, 2025 12:54
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.

Fantastic! thanks for getting all of these examples nicely defined in the same way

@charlieegan3 charlieegan3 enabled auto-merge (squash) June 25, 2025 13:00
@charlieegan3 charlieegan3 merged commit 1679d79 into open-policy-agent:main Jun 25, 2025
31 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.

2 participants