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.

Sign up for GitHub

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

Jump to bottom

Add documentation section on capabilities #3769

Closed
tsandall opened this issue Aug 31, 2021 · 2 comments · Fixed by #3839
Closed

Add documentation section on capabilities #3769

tsandall opened this issue Aug 31, 2021 · 2 comments · Fixed by #3839
Assignees
@peteroneilljr
Labels
docs

Comments

@tsandall
Copy link
Member

tsandall commented Aug 31, 2021 •
edited
Loading

We don't currently have a documentation section on capabilities. Since capabilities could be used during build-time or deploy-time, it's unclear what the right location is for them in the docs. I could imagine just adding them to the deployment docs for the time being and refactoring them later. The docs should:

  • Explain why capabilities exist
  • Show the capabilities structure and features
  • Show an example with opa build

Resources:
@tsandall tsandall added the docs label Aug 31, 2021
@peteroneilljr peteroneilljr self-assigned this Sep 1, 2021
@peteroneilljr
Copy link
Member

peteroneilljr commented Sep 24, 2021 •
edited
Loading

Working draft located here

I installed the latest Hugo version, so my local rendering is kinda borked. I tried to render it directly in Netlify but it doesn't pick up any of the changes I've made. So I'm just looking for a way to validate my changes before submitting a PR.

@peteroneilljr
Copy link
Member

Unblocked: Latest releases live under /edge.
https://deploy-preview-1--serene-shockley-45be55.netlify.app/docs/edge/deployments/#capabilities

The next step is to add the available capabilities from the code into the docs.
https://github.com/open-policy-agent/opa/blob/main/ast/capabilities.go

@peteroneilljr peteroneilljr mentioned this issue Sep 30, 2021
Merged
srenatus pushed a commit that referenced this issue Oct 4, 2021
@peteroneilljr
docs/deployments: add capabilities section (#3839)
5acbfc9 
Adding in instructions to the OPA docs on how to use capabilities feature.

Fixes: #3769

Signed-off-by: Peter ONeill <peteroneilljr@gmail.com>
dolevf pushed a commit to dolevf/opa that referenced this issue Nov 4, 2021
@peteroneilljr @dolevf
docs/deployments: add capabilities section (open-policy-agent#3839)
bd0b3e1 
Adding in instructions to the OPA docs on how to use capabilities feature.

Fixes: open-policy-agent#3769

Signed-off-by: Peter ONeill <peteroneilljr@gmail.com>
Signed-off-by: Dolev Farhi <farhi.dolev@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@peteroneilljr peteroneilljr

Labels
docs
Projects
Open Policy Agent
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docs add capabilities section
2 participants
@tsandall @peteroneilljr