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: add playground examples codegen docs #180

Merged
merged 1 commit into from
Nov 1, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .docs/PLAYGROUND_EXAMPLES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Playground examples docs

This docs contains information to manage playground examples.

## Modify playground examples

To add, update or remove a playground example edit the [playground-examples.yaml](../playground-examples.yaml) file.

This file contains two nested maps, first level is the example category and second level is example name:

```yaml
example category 1:
example name 1:
policy: path/to/policy/file (yaml or json)
payload: path/to/payload/file (yaml or json)
example name 2:
policy: path/to/policy/file (yaml or json)
payload: path/to/payload/file (yaml or json)
example category 2:
# ...
```

Once the file edited, run `make codegen-playground-examples` to update the [data.json](../website/playground/assets/data.json) file.
Loading