docs: add compile API docs #7939
Conversation
srenatus
force-pushed
the
sr/quqyssromwkz
branch
2 times, most recently
from
d0acead to
80e2aeb
Compare
✅ Deploy Preview for openpolicyagent ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for openpolicyagent ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| items: [ | ||
| { type: "autogenerated", dirName: "filtering" }, | ||
| ], | ||
| }, |
There was a problem hiding this comment.
Happy to discuss a better place, or rank, for this category 😎
srenatus
force-pushed
the
sr/quqyssromwkz
branch
from
80e2aeb to
e1a3f05
Compare
charlieegan3
force-pushed
the
sr/quqyssromwkz
branch
from
e1a3f05 to
12b35be
Compare
| title: Overview | ||
| sidebar_position: 1 | ||
| --- | ||
|
|
There was a problem hiding this comment.
I feel like some preamble here would be helpful, outlining what this new section is all about and what the value we can offer for the use case is.
| </SideBySideColumn> | ||
| </SideBySideContainer> | ||
|
|
||
| --- |
There was a problem hiding this comment.
Is there any reason in particular reason to have these? We tend not to have them quite so often on other pages.
There was a problem hiding this comment.
It's separating the steps... The content would work better as a slide-show, but that's too much for the docs. I can remove them, but I think it doesn't work out too bad this way, do you?
There was a problem hiding this comment.
Yeah I don't have strong feelings - perhaps numbered steps would make it clear too? just an idea...
There was a problem hiding this comment.
Would you mean like "Step 1", "Step 2", ... subheadings?
There was a problem hiding this comment.
It could be worth a shot, but not essential and don't waste time with it if it doesn't look right with the default markdown available.
docs/docs/filtering/fragment.md
Outdated
| @@ -0,0 +1,218 @@ | |||
| --- | |||
| title: Writing valid data filtering policies | |||
There was a problem hiding this comment.
| title: Writing valid data filtering policies | |
| title: Writing Valid Data Filtering Policies |
docs/docs/filtering/column-masks.md
Outdated
| <TabItem value="rego" label="filters.rego" default> | ||
|
|
||
| ```rego | ||
docs/docs/filtering/column-masks.md
Outdated
|
|
||
| #### Request | ||
|
|
||
| ```http |
There was a problem hiding this comment.
| ```http | |
| ```http title="Request" |
We can also do this, if you don't need the anchor
There was a problem hiding this comment.
Beautilful 👨🍳 Thanks for the hint!
docs/docs/filtering/column-masks.md
Outdated
|
|
||
| #### Response | ||
|
|
||
| ```http |
There was a problem hiding this comment.
| ```http | |
| ```http title="Response" |
Upon reading this again, I found it confusing. I think it's slightly less so now. Also adds a row for the lonely statements supported in the next release. Signed-off-by: Stephan Renatus <[email protected]>
This is everything we've had in EOPA, with updated cross-references, updated annotations (custom -> compile) and headers. This is work done in another repository, so I'll collect co-authors on this commit message's trailers. Co-authored-by: Philip Conrad <[email protected]> Co-authored-by: Chris Hendrix <[email protected]> Signed-off-by: Stephan Renatus <[email protected]>
srenatus
force-pushed
the
sr/quqyssromwkz
branch
3 times, most recently
from
e2ff8df to
2f67550
Compare
Signed-off-by: Stephan Renatus <[email protected]>
srenatus
force-pushed
the
sr/quqyssromwkz
branch
from
2f67550 to
303e5c3
Compare
2 participants
Follow-up to #7887.