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

Documentation on base/virtual document lost in upgrade #2284

Closed
anderseknert opened this issue Apr 9, 2020 · 1 comment · Fixed by #2314
Closed

Documentation on base/virtual document lost in upgrade #2284

anderseknert opened this issue Apr 9, 2020 · 1 comment · Fixed by #2314
Assignees
Labels

Comments

@anderseknert
Copy link
Member

Expected Behavior

The docs used to have a section on the base document, virtual documents and their relation to policies: https://www.openpolicyagent.org/docs/v0.13.5/how-does-opa-work/

These docs were very useful to help connect the OPA dots!

Actual Behavior

No current documentation covering the topic.

Additional Info

There are still links scattered around in the docs pointing to the "how-does-opa-work" page for en explanation of the base/virtual document, though that's not really explained by that page anymore.

@tsandall
Copy link
Member

tsandall commented Apr 9, 2020

Thanks for filing this @anderseknert! We'll bring this page back (albeit not inside the intro) soon.

@tsandall tsandall added the docs label Apr 9, 2020
@tsandall tsandall self-assigned this Apr 9, 2020
tsandall added a commit to tsandall/opa that referenced this issue Apr 21, 2020
When we refreshed the docs last year we removed the page titled 'how
OPA works' and in the process lost the description of the OPA document
model that explains the base and virtual document concepts. Since then
a bunch of people have referred back to those docs after getting
started.

This change re-introduces the model and provides an explanation of
_why_ the model exists.

This change also replaces the infographic with text containing the
same content as that feels a bit more inline with the rest of the
page.

Fixes open-policy-agent#2284

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
tsandall added a commit that referenced this issue Apr 21, 2020
When we refreshed the docs last year we removed the page titled 'how
OPA works' and in the process lost the description of the OPA document
model that explains the base and virtual document concepts. Since then
a bunch of people have referred back to those docs after getting
started.

This change re-introduces the model and provides an explanation of
_why_ the model exists.

This change also replaces the infographic with text containing the
same content as that feels a bit more inline with the rest of the
page.

Fixes #2284

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants