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: Migrate examples to live blocks. #1650

Closed
20 of 23 tasks
david-boles opened this issue Aug 21, 2019 · 0 comments
Closed
20 of 23 tasks

docs: Migrate examples to live blocks. #1650

david-boles opened this issue Aug 21, 2019 · 0 comments
Assignees
Labels

Comments

@david-boles
Copy link
Contributor

david-boles commented Aug 21, 2019

  • ceph-authorization
  • comparison-to-other-systems (* one example done)
  • decision-logs
  • deployments
  • discovery
  • docker-authorization
  • faq
  • get-started
  • how-do-i-integrate-opa
  • how-do-i-test-policies
  • how-do-i-write-policies
  • how-does-opa-work
  • http-api-authorization
  • kafka-authorization
  • kubernetes-debugging
  • kubernetes-introduction
  • kubernetes-primer
  • kubernetes-tutorial
  • language-cheatsheet
  • rest-api
  • security
  • ssh-and-sudo-authorization
  • terraform
@david-boles david-boles changed the title docs: Migrate examples to live-blocks. docs: Migrate examples to live blocks. Aug 21, 2019
@tsandall tsandall added the docs label Aug 22, 2019
@tsandall tsandall self-assigned this Aug 22, 2019
tsandall added a commit to tsandall/opa that referenced this issue Aug 23, 2019
These changes update most of the docs to use live blocks. The
following pages have not been touched or updated significantly:

* Get Started - this page is based entirely on the REPL. We should
  revisit the "Get Started" page once these changes have
  landed. The existing page can live on as an introduction to the REPL
  while the Get Started page can be tailored to live blocks.

* Ceph Authorization - this page has not been updated aside from
  making the policy example use the live blocks for syntax
  highlighting. We need to revisit the policy example and refactor the
  tutorial a bit to emphasize the policy as opposed to the manifests
  required to install.

* Terraform - this page has not been touched because @vgramer is
  planning to update for Terraform v0.12. We can update this page once
  those changes are in to avoid conflicts.

These changes also remove the use of non-Markdown code examples. All
the examples are inlined into Markdown now.

A few OPA deployment examples have been updated to enable the console
decision logging. This is better than the request/response debug logs.

Fixes open-policy-agent#1650

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

No branches or pull requests

2 participants