Updated with changes by Asaf

Daniel · Daniel · commit e21db7440d7c · 2021-12-14T17:44:43.000+02:00
diff --git a/docs/HOWTO/get_started_with_opal_docker_compose_tutorial.md b/docs/HOWTO/get_started_with_opal_docker_compose_tutorial.md
@@ -1,4 +1,4 @@
-# Get started with OPAL (a docker-compose playground)
+# 🚀  Get started with OPAL (a docker-compose playground)
 
 This tutorial will show you what you can do with OPAL, and teach you about OPAL core features.
 
diff --git a/docs/HOWTO/get_started_with_opal_python_packages.md b/docs/HOWTO/get_started_with_opal_python_packages.md
@@ -12,7 +12,7 @@ This guide will teach you how to setup and use OPAL as Python packages (python 3
     export OPAL_AUTH_PUBLIC_KEY=~/opal.pub 
     export OPAL_AUTH_MASTER_TOKEN="RANDOM-SECRET-STRING"
     #  Watching a GIT repository from a webhook
-    export OPAL_POLICY_REPO_URL=https://github.com/authorizon/opal-example-policy-repo.git
+    export OPAL_POLICY_REPO_URL=https://github.com/permitio/opal-example-policy-repo.git
     export OPAL_POLICY_REPO_WEBHOOK_SECRET="RANDOM-SECRET-STRING-SHARED-WITH-GITHUB"
     opal-server run
     ```
@@ -60,6 +60,7 @@ for example `OPAL_SERVER_PORT=1337 opal-server run` is equivalent to `opal-serve
 
 
 ----------------------------
+</br>
 
 ## Setup OPAL-server
 
diff --git a/docs/HOWTO/get_started_with_opal_using_docker.md b/docs/HOWTO/get_started_with_opal_using_docker.md
@@ -1,4 +1,4 @@
-# Get started with OPAL docker containers
+# 🚀  Get started with OPAL docker containers
 
 This tutorial will teach you how to run OPAL using the official docker images.
 
@@ -49,7 +49,7 @@ Our recommendation is to start with the [docker-compose playground](https://gith
       <th align="left" width="45%">Description</th>
     </tr>
     <tr>
-      <td valign="top"><a href="https://hub.docker.com/r/authorizon/opal-server">OPAL Server</a></td>
+      <td valign="top"><a href="https://hub.docker.com/r/permitio/opal-server">OPAL Server</a></td>
       <td valign="top"><code>docker pull authorizon/opal-server</code></td>
       <td valign="top">
       <ul>
@@ -62,7 +62,7 @@ Our recommendation is to start with the [docker-compose playground](https://gith
       </td>
     </tr>
     <tr>
-      <td valign="top"><a href="https://hub.docker.com/r/authorizon/opal-client">OPAL Client</a></td>
+      <td valign="top"><a href="https://hub.docker.com/r/permitio/opal-client">OPAL Client</a></td>
       <td valign="top"><code>docker pull authorizon/opal-client</code></td>
       <td valign="top">
       <ul>
diff --git a/docs/design.md b/docs/design.md
@@ -5,7 +5,7 @@
 OPAL is built on the shoulders of open-source giants, including:
 - [Open Policy Agent](https://www.openpolicyagent.org/)- the default policy agent managed by OPAL.
 - [FastAPI](https://github.com/tiangolo/fastapi) - the ASGI API framework used by OPAL-servers and OPAL-clients.
-- [FastAPI Websocket PubSub](https://github.com/authorizon/fastapi_websocket_pubsub) - powering the live realtime update channels
+- [FastAPI Websocket PubSub](https://github.com/permitio/fastapi_websocket_pubsub) - powering the live realtime update channels
 - [Broadcaster](https://pypi.org/project/broadcaster/) allowing syncing server instances through a backend backbone (e.g. Redis, Kafka)
 
 ## <a name="key-concepts"></a>💡 Key Concepts
@@ -26,13 +26,13 @@ OPAL is built on the shoulders of open-source giants, including:
 ## <a name="design"></a> ✏️ Design choices
 
 - ### Networking
-    - OPAL creates a highly efficient communications channel using [websocket Pub/Sub connections](https://github.com/authorizon/fastapi_websocket_pubsub) to subscribe to both data and policy updates. This allows OPAL clients (and the services they support) to be deployed anywhere - in your VPC, at the edge, on-premises, etc.
+    - OPAL creates a highly efficient communications channel using [websocket Pub/Sub connections](https://github.com/permitio/fastapi_websocket_pubsub) to subscribe to both data and policy updates. This allows OPAL clients (and the services they support) to be deployed anywhere - in your VPC, at the edge, on-premises, etc.
     - By using **outgoing** websocket connections to establish the Pub/Sub channel most routing/firewall concerns are circumnavigated.
     - Using Websocket connections allows network connections to stay idle most of the time, saving CPU cycles for both clients and servers (especially when comparing to polling-based methods).
 
 - ### Implementation with Python
     - OPAL is written completely in Python3 using asyncio, FastAPI and Pydantic.
-    OPAL was initially created as a component of [**auth**orizon.com](https://www.authorizon.com), and we've chosen Python for development speed, ease of use and extensibility (e.g. fetcher providers).
+    OPAL was initially created as a component of [Permit.io](https://www.permit.io), and we've chosen Python for development speed, ease of use and extensibility (e.g. fetcher providers).
     - Python3 with coroutines (Asyncio) and FastAPI has presented [significant improvements for Python server performance](https://www.techempower.com/benchmarks/#section=test&runid=7464e520-0dc2-473d-bd34-dbdfd7e85911&hw=ph&test=composite&a=2&f=zik0zj-qmx0qn-zhwum7-zijx1b-z8kflr-zik0zj-zik0zj-zijunz-zik0zj-zik0zj-zik0zj-1kv). While still not on par with Go or Rust - the results match and in some cases even surpass Node.js.
 
 - ### Performance
@@ -50,7 +50,7 @@ OPAL is built on the shoulders of open-source giants, including:
     - OPAL was built initially with OPA in mind, and OPA is mostly a first-class citizen in OPAL. That said OPAL can support various and multiple policy agents, even in parallel - allowing developers to choose the best policy agent for their needs.
 
 - ### <a name="large-scale-fga"></a> FGA, large scale / global authorization (e.g. Google Zanzibar)
-    - OPAL is built for fine grained authorizon (FGA), allowing developers to aggregate all and any data they need and restructure it for the authorization layer.
+    - OPAL is built for fine grained authorization (FGA), allowing developers to aggregate all and any data they need and restructure it for the authorization layer.
     - OPAL achieves this by making sure each policy-agent is loaded with only the data it needs via topic subscriptions (i.e: data focus and separation).
         - Examples of data separation: the back-office service doesn't need to know about customer users, a tenant specific service doesn't need the user list of other tenants, ...
     - That said OPAL is still limited by OPA's [resource utilization capacity](https://www.openpolicyagent.org/docs/latest/policy-performance/#resource-utilization).
@@ -64,5 +64,5 @@ OPAL is built on the shoulders of open-source giants, including:
     - If you'd like to use OPAL or some of its underlying modules for other update cases - please contact us (See below), we'd love to help you do that.
 
 - ### Administration capabilities and UI
-    - We've already built policy editors, back-office, frontend-embeddable interfaces, and more as part of [**auth**orizon.com](https://www.authorizon.com).
-    - We have plans to migrate more parts of [**auth**orizon.com](https://www.authorizon.com) to be open-source; please let us know what you'd like to see next.
+    - We've already built policy editors, back-office, frontend-embeddable interfaces, and more as part of [Permit.io](https://permit.io).
+    - We have plans to migrate more parts of [Permit.io](https://permit.io) to be open-source; please let us know what you'd like to see next.
diff --git a/docs/index.md b/docs/index.md
@@ -22,7 +22,7 @@ Check out OPAL's main site at <a href="https://opal.ac">OPAL.ac</a>
   - [Code modules](modules.md) review
 
 ## 👩‍🏫 <a name="how-tos"></a> HOW-TOs
-- [How to get started with OPAL (Packages and CLI)](HOWTO/get_started_with_opal.md)
+- [How to get started with OPAL (Packages and CLI)](HOWTO/get_started_with_opal_python_packages.md)
 - [How to get started with OPAL (Container Images)](HOWTO/get_started_with_opal_using_docker.md)
 - [How to trigger Data Updates via OPAL](HOWTO/trigger_data_updates.md)
 - [How to extend OPAL to fetch data from your sources with FetchProviders](HOWTO/write_your_own_fetch_provider.md)
diff --git a/docs/intro.md b/docs/intro.md
@@ -1,5 +1,9 @@
 # <a name="intro"></a>💡 Introduction to OPAL - data and policy realtime delivery
-- Modern applications are complex, distributed, multi-tenant and run at scale - often creating overwhelming authorization challenges. OPA (Open-Policy-Agent) brings the power of decoupled policy to the infrastructure layer (especially K8s), and light applications. OPAL supercharges OPA to meet the pace of live applications, where the state relevant to authorization decisions may change with every user click and api call.
+Modern applications are complex, distributed, multi-tenant and run at scale - often creating overwhelming authorization challenges. 
+
+OPA (Open-Policy-Agent) brings the power of decoupled policy to the infrastructure layer (especially K8s), and light applications. 
+
+OPAL supercharges OPA to meet the pace of live applications, where the state relevant to authorization decisions may change with every user click and api call.
 
 - OPAL builds on top of OPA adding realtime updates (via Websocket Pub/Sub) for both policy and data.
 
@@ -8,10 +12,10 @@
 ### <a name="why-use-opal"></a> Why use OPAL
 - OPAL is the easiest way to keep your solution's authorization layer up-to-date in realtime.
     - OPAL aggregates policy and data from across the field and integrates them seamlessly into the authorization layer. 
-    - OPAL is microservices and cloud-native (see [key concepts](#key-concepts) below) 
+    - OPAL is microservices and cloud-native (see [Key concepts and design](design.md))
 
 ### Why OPA + OPAL == 💪 💜
-OPA (Open Policy Agent) is great! It decouples policy from code in a highly-performant and elegant way. But the challege of keeping policy agents up-to-date is hard - especially in applications - where each user interaction or API call may affect access-control decisions.
+OPA (Open Policy Agent) is great! It decouples policy from code in a highly-performant and elegant way. But the challenge of keeping policy agents up-to-date is hard - especially in applications - where each user interaction or API call may affect access-control decisions.
 OPAL runs in the background, supercharging policy-agents, keeping them in sync with events in realtime.
 
 ### What OPAL *is not*
@@ -21,13 +25,12 @@ OPAL runs in the background, supercharging policy-agents, keeping them in sync w
 
     </br>
 - Large scale Global FGA: 
-    - Currently OPAL is not meant for managing ridiculous (>100GB) amounts of data  within one layer. Though it can complement a CDN to achieve a similar result - [see below](#large-scale-fga).
+    - Currently OPAL is not meant for managing ridiculous (>100GB) amounts of data  within one layer. Though it can complement a CDN to achieve a similar result - see [Key concepts and design](design.md#"large-scale-fga).
     - Check out <a href="https://research.google/pubs/pub48190/" target="_blank">Google-Zanzibar</a>
         
          </br>
 - Fullstack authorization: 
     - OPAL and OPA essentially provide microservices for authorization
     - Developers still need to add control interfaces on top (e.g. user-management, api-key-management, audit, impersonation, invites) both as APIs and UIs 
-    - Check out <a href="https://authorizon.com" target="_blank">**auth**orizon</a>
-
+    - Check out <a href="https://permit.io" target="_blank">Permit.io</a>
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Get started with OPAL (a docker-compose playground)`
	`1`	`+# 🚀 Get started with OPAL (a docker-compose playground)`
`2`	`2`
`3`	`3`	`This tutorial will show you what you can do with OPAL, and teach you about OPAL core features.`
`4`	`4`