Skip to content

Commit

Permalink
docs: Update to use live blocks
Browse files Browse the repository at this point in the history
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 #1650

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
  • Loading branch information
tsandall committed Aug 23, 2019
1 parent 64139d6 commit 74d67c5
Show file tree
Hide file tree
Showing 32 changed files with 994 additions and 826 deletions.
2 changes: 1 addition & 1 deletion docs/content/ceph-authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -963,7 +963,7 @@ As we saw earlier, the OPA spec contained a ConfigMap that defined the policy to

**authz.rego**

```ruby
```live:example:module:read_only
package ceph.authz
default allow = false
Expand Down
3 changes: 0 additions & 3 deletions docs/content/code/deployments-docker/example/data.json

This file was deleted.

6 changes: 0 additions & 6 deletions docs/content/code/deployments-docker/example/policy.rego

This file was deleted.

33 changes: 0 additions & 33 deletions docs/content/code/deployments-kubernetes/deployment-opa.yaml

This file was deleted.

20 changes: 0 additions & 20 deletions docs/content/code/deployments-kubernetes/example-pod.json

This file was deleted.

7 changes: 0 additions & 7 deletions docs/content/code/deployments-kubernetes/example.rego

This file was deleted.

15 changes: 0 additions & 15 deletions docs/content/code/deployments-kubernetes/service-opa.yaml

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading

0 comments on commit 74d67c5

Please sign in to comment.