opa icon indicating copy to clipboard operation
opa copied to clipboard

docs on creating bundles are incomplete

Open bluebrown opened this issue 2 years ago • 5 comments

Hi, I noticed that there is no complete example in the docs on how to create a bundle including entrypoint and data. There is this one https://www.openpolicyagent.org/docs/latest/management-bundles/#bundle-build which uses the optimize flag, but the example is broken because you cannot optimize a bundle without an entrypoint.

I think it would be good if there was a more comprehensive guide on how to create bundles, including entrypoint and multiple json data files for separation of concerns.

bluebrown avatar Nov 10 '22 10:11 bluebrown

This issue has been automatically marked as inactive because it has not had any activity in the last 30 days.

stale[bot] avatar Dec 11 '22 19:12 stale[bot]

Hello sir, I would like to work on this issue, Can You please assign it to me.

ashutoshak5386 avatar Sep 05 '23 16:09 ashutoshak5386

Sure @ashutoshak5386 go for it! Thanks for volunteering!

ashutosh-narkar avatar Sep 05 '23 17:09 ashutosh-narkar

Hi @ashutosh-narkar where should I add the documentation? should it be in the readme file itself or there's a separate document folder?

ashutoshak5386 avatar Sep 07 '23 07:09 ashutoshak5386

Hi @ashutoshak5386, the file that contains the content for this page can be found here: https://github.com/open-policy-agent/opa/blob/main/docs/content/management-bundles.md. I'd say that the main thing to address is the faulty example with the --optimize flag.

charlieegan3 avatar Sep 07 '23 09:09 charlieegan3