CR fixes

Signed-off-by: orweis <[email protected]>
permitio · Jul 27, 2023 · 3d6bf2c · 3d6bf2c
1 parent 5d90e5b
commit 3d6bf2c
Showing 1 changed file with 8 additions and 4 deletions.
diff --git a/documentation/docs/getting-started/tldr.mdx b/documentation/docs/getting-started/tldr.mdx
@@ -11,17 +11,21 @@ The OPAL server sends instructions to the OPAL-clients (via pub/sub subscription
 OPAL tracks [policies from Git](/tutorials/track_a_git_repo) or from [API bundle servers](/tutorials/track_an_api_bundle_server).
 
 With Git - directories with policy-code (e.g. `.rego` or `.cedar` files) are automatically mapped to topics - which a client can subscribe to with `OPAL_POLICY_SUBSCRIPTION_DIRS`
-Every time you push a change, OPAL server will notify the subscribing OPAL-clients to load the new policy.
+Every time you push a change, the OPAL server will notify the subscribing OPAL-clients to load the new policy.
 
 ### Data
 
 OPAL tracks data from various sources via webhooks and [Fetch-Providers](/tutorials/write_your_own_fetch_provider) (extensible python modules that teach it to load data from sources).
 
 [Initial data is indicated by the server](getting-started/running-opal/run-opal-server/data-sources) based on `OPAL_DATA_CONFIG_SOURCES`.
 Subsequent data updates are triggered via [the data update webhook](/tutorials/trigger_data_updates).
-Every time the policy agent (or it's managing OPAL-client) restarts data and policy are loaded from scratch.
+Every time the policy agent (or it's managing OPAL-client) restarts, the data and policy are loaded from scratch.
 
 #### Data as part of policy bundle
 
-Data can also be loaded with the policy as part of `data.json` files in folders next to policy file.
-The folder path is used as the key path in the policy engine cache. (Avoid race conditions with regular data updates, by directing data from each to different keys)
+Data can also be loaded with the policy as part of `data.json` files, located in the folders next to the policy file.
+
+:::note
+The **folder path** is used as the **key path** in the policy engine cache.
+In order to avoid race conditions between policy data updates and regular data updates, make sure the key paths used by your policy-data and the ones used by your data-updates are different.
+:::