Commit Graph

13 Commits

Author SHA1 Message Date
Torin Sandall a9b41cb01b docs: Fix preprocessing to fetch OPA binary correctly
Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2019-09-12 18:59:04 -04:00
Torin Sandall 65cc5f8446 docs: Activate live blocks on the latest version of the docs
Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2019-09-12 18:06:53 -04:00
Torin Sandall 583b67cb57 docs: Refresh the introduction page
This commit updates the introduction page to focus on Rego and
integrating with OPA (whereas the old introduction content focused on
high-level concepts like policy-decoupling, the data document, etc.)

The new introduction content provides a concise overview of OPA and
then launches into an tour of Rego (by example) that shows the core
concepts in the language. The content ends with an overview of
different ways you can interact with OPA.

The old introduction content has been moved into the Philosophy page
and the How Does OPA Work? page has been removed/replaced by the new
introduction page.

With these changes we can update the frontpage with links to core OPA
introduction and then different use cases (e.g., Kubernetes, Envoy,
etc.)

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2019-09-11 13:36:19 -04:00
Patrick East 7a9a78fa2a docs: Use full copy for latest instead of shadow
Instead of using url rewriting tricks we will just copy the latest
docs as part of the build process for a "latest" version.

In the version selector code we need to handle this to hide the
version, but overall it simplifies the template code.. so thats nice.

Best part, and main reason for doing this, is that the pretty url
feature will now work on the `/docs/latest/*` urls. It will fix some
weirdness with the relative url links we use in the markdown content
and remove a duplicate search result.

Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-09-10 09:58:50 -07:00
Patrick East 13f1de2982 docs: Stop showing versions <0.10.7
This lets us simplify some of the code and there isn't really a great
reason to keep the older docs up at this point.

Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-09-10 09:58:50 -07:00
Patrick East 968ad5919c docs: Fix load-docs.sh when HEAD is both a tag and branch
If there was a tag and branch that both referenced HEAD it would
return to the tag instead of branch. This change gives priority to
the branch if the current HEAD corresponds to one.

Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-09-10 09:58:50 -07:00
Patrick East 6b6dd1cf83 docs: remove lint step from live-blocks
This should fix the critical vulnerability found by scanners in the
eslint-utils package by removing the lint script.

We can re-visit this again in the future when someone can spend more
time to fix it.

Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-09-05 19:18:36 -06:00
David Boles 9618e9d35a live-blocks: Added an include(<group name>) tag.
Signed-off-by: David Boles <me@davidbol.es>
2019-08-29 09:28:45 -07:00
David Boles da95397588 docs: Minor live blocks fixes and improvements.
Allow "open" button for read_only blocks.

Remove erroneous CSS.

Added a tag for showing line numbers.

Signed-off-by: David Boles <me@davidbol.es>
2019-08-23 17:43:25 -07:00
Torin Sandall 983dfd4435 docs: Fix package parsing in preprocessor
The regexp was not allowing comments at the end of the line.

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
2019-08-23 16:50:32 -04:00
David Boles 91d98c7205 docs: Add live-editable code blocks to the docs.
This commit adds a postprocessor to the docs build that enables
examples to be edited and have the results show up live. See the
additions to `docs/README.md` for more about what writing these
blocks looks like or the netlify PR preview
(e.g. at `docs/edge/how-do-i-write-policies/`)
to see them in action (you'll need to disable CORS for live output).

Signed-off-by: David Boles <me@davidbol.es>
2019-08-21 10:12:49 -07:00
Patrick East 994997479f Remove "RELEASES" file from docs/website build
We were using a file with hard coded versions to display docs for, but
this complicates things if/when we need to do patch releases on
different branches from master.

Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-06-13 11:31:58 -07:00
Patrick East 58d336aff9 Refactor doc directories
Signed-off-by: Patrick East <east.patrick@gmail.com>
2019-04-26 17:12:15 -07:00