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

Docs: More details into utilizing the examples #242

Open
nmccready opened this issue Jun 7, 2022 · 9 comments
Open

Docs: More details into utilizing the examples #242

nmccready opened this issue Jun 7, 2022 · 9 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@nmccready
Copy link

The main readme only goes into depth for running the compose file. For those trying to experiment with http://localhost:8181/ it would be nice to have some query and scenarios to walk through.

@nmccready nmccready added the bug Something isn't working label Jun 7, 2022
@orweis orweis added good first issue Good for newcomers documentation Improvements or additions to documentation and removed bug Something isn't working labels Jun 7, 2022
@orweis
Copy link
Contributor

orweis commented Jun 7, 2022

Good idea; though it's more of a documentation issue than a bug; so I've updated the label.

@nmccready
Copy link
Author

Yeah i would have changed the label but I am not allowed.

@nmccready
Copy link
Author

nmccready commented Jun 8, 2022

Example after tinkering and looking here at query.

{
  "result": [
    {
      "i": "alice"
    }
  ]
}

For others that are not following the data you are querying is here https://github.com/permitio/opal-example-policy-repo/blob/master/data.json

@kunalranjan19
Copy link

hey would love to work on it but the localhost is not opening

@orweis
Copy link
Contributor

orweis commented Jul 14, 2022

HI @kunalranjan19 - what do you mean by " localhost is not opening"? Are you running the OPAL-client with OPA in place?

@lakshyabhasin509
Copy link

Hey guys ,i would like to work on this issue , i have done the example policy setup and just trying to understand how is Opal and OPA are working.

@orweis
Copy link
Contributor

orweis commented Aug 27, 2022

Hi @lakshyabhasin509 that would be wonderful, feel free to submit these as .md files in a pull request.

Let us know if you need any guidance here

FYI: @filipermit

@DevOpsGodd
Copy link

any one worked on this yet? i am interested in doing this. but would be needing a little guide.

@orweis
Copy link
Contributor

orweis commented Jan 18, 2023

Hi @Uthycloud - I think this one is up for grabs :)
Both @filipermit and I would be happy to provide guidance.

A good place to start is going yourself through the steps here: https://docs.opal.ac/getting-started/quickstart/opal-playground/overview

And then you can add more examples here: https://github.com/permitio/opal/tree/master/documentation/docs/getting-started/quickstart/opal-playground.

I'd suggest each example starts with showing loading policy and/or data with OPAL, and then checking on the result with queries directly to OPA (sharing both the policy, data, commands and queries being sent as part of the example).
You can draw inspiration, or even use as is the example we show in this recorded demo: https://youtu.be/A5adHlkmdC0?t=1297

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

6 participants