From ce3a73b08575d30fbbc47762e296d34577a34e93 Mon Sep 17 00:00:00 2001 From: Patrick East Date: Fri, 20 Mar 2020 17:48:18 -0700 Subject: [PATCH] docs: Add IDE and Editor section to docs website This basically just moves the README from the syntax folder into the website content and adds links to all of the editor syntax files we have in the repo (in alphabetical order). Signed-off-by: Patrick East --- docs/content/_index.md | 2 ++ docs/content/editor-and-ide-support.md | 24 ++++++++++++++++++++++++ misc/syntax/README.md | 12 ------------ 3 files changed, 26 insertions(+), 12 deletions(-) create mode 100644 docs/content/editor-and-ide-support.md delete mode 100644 misc/syntax/README.md diff --git a/docs/content/_index.md b/docs/content/_index.md index 51c69e3650..6197a457bf 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -1044,3 +1044,5 @@ Some popular tutorials include: * The [Kubernetes](kubernetes-introduction) page for how to use OPA as an admission controller in Kubernetes. * The [Envoy](envoy-authorization) page for how to use OPA as an external authorizer with Envoy. * The [Terraform](terraform) page for how to use OPA to validate Terraform plans. + +Don't forget to install the OPA (Rego) Plugin for your favorite [IDE or Text Editor](editor-and-ide-support) diff --git a/docs/content/editor-and-ide-support.md b/docs/content/editor-and-ide-support.md new file mode 100644 index 0000000000..5b2c8f303c --- /dev/null +++ b/docs/content/editor-and-ide-support.md @@ -0,0 +1,24 @@ +--- +title: Editor and IDE Support +kind: misc +weight: 11 +--- + +OPA can be integrated into editors and IDEs to provide features like syntax highlighting, query +evaluation, policy coverage, and more. + +## Integrations + +> Note: See each integration for what features are supported! Not all support the same features. + +| Editor | Link | +| --- | --- | +| Atom | [https://github.com/open-policy-agent/opa/tree/master/misc/syntax/atom](https://github.com/open-policy-agent/opa/tree/master/misc/syntax/atom) | +| Sublime Text | [https://github.com/open-policy-agent/opa/tree/master/misc/syntax/sublime](https://github.com/open-policy-agent/opa/tree/master/misc/syntax/sublime) | +| TextMate | [https://github.com/open-policy-agent/opa/tree/master/misc/syntax/textmate](https://github.com/open-policy-agent/opa/tree/master/misc/syntax/textmate) | +| Vim | [https://github.com/tsandall/vim-rego](https://github.com/tsandall/vim-rego) | +| Visual Studio Code | [https://marketplace.visualstudio.com/items?itemName=tsandall.opa](https://marketplace.visualstudio.com/items?itemName=tsandall.opa) | + +## Rego Playground + +The Rego Playground provides a great editor to get started with OPA and share policies. Try it out at [https://play.openpolicyagent.org/](https://play.openpolicyagent.org/) diff --git a/misc/syntax/README.md b/misc/syntax/README.md deleted file mode 100644 index 349043e2f2..0000000000 --- a/misc/syntax/README.md +++ /dev/null @@ -1,12 +0,0 @@ -# Editor and IDE Support - -OPA can be integrated into editors and IDEs to provide features like query -evaluation, policy coverage, and more. This directory contains simple syntax -highlighters for common editors. - -## Integrations - -| Editor | Link | -| --- | --- | -| Vim | [https://github.com/tsandall/vim-rego](https://github.com/tsandall/vim-rego) | -| Visual Studio Code | [https://github.com/tsandall/vscode-opa](https://github.com/tsandall/vscode-opa) | \ No newline at end of file