typos, uniformity fixes in docs (#131)

Co-authored-by: Shaobo He <shaobohe@amazon.com>
cedar-policy · May 22, 2024 · 52a9825 · 52a9825
1 parent d88c0da
commit 52a9825
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 9 deletions.
diff --git a/cedar-example-use-cases/README.md b/cedar-example-use-cases/README.md
@@ -1,7 +1,7 @@
 # Cedar Example Use Cases
 
 This repository contains Cedar policies that model the authorization logic of two example applications.
-[Document cloud drive example](./document_cloud) models a cloud-based document sharing system, like Google Drive or Dropbox. [GitHub example](./github_example/) mimics GitHub's repository access permissions.
+The [document cloud drive example](./document_cloud) models a cloud-based document sharing system, like Google Drive or Dropbox. The [GitHub example](./github_example/) mimics GitHub's repository access permissions.
 
 ## Quick Start
 
@@ -28,9 +28,9 @@ Use the `run.sh` script to validate the policies and run every authorization tes
 
 | File  | Description |
 | ------------- | ------------- |
-| `policies.cedar`  | Cedar policies for authorization management  |
-| `entities.json`  | Example entity store  |
-| `*.cedarschema.json` | Example schema |
+| `policies.cedar`  | Cedar policies  |
+| `entities.json`  | Sample entity store  |
+| `policies.cedarschema` | Cedar schema |
 | `allow_requests` | Allowed requests |
 | `deny_requests` | Denied requests |
-| `README.md` | A tutorial walking through the example application |
+| `README.md` | A tutorial walking through the application |
diff --git a/...document_cloud/document_cloud.cedarschema → ...cases/document_cloud/policies.cedarschema b/...document_cloud/document_cloud.cedarschema → ...cases/document_cloud/policies.cedarschema
diff --git a/...github_example/github_example.cedarschema → ...cases/github_example/policies.cedarschema b/...github_example/github_example.cedarschema → ...cases/github_example/policies.cedarschema
diff --git a/cedar-example-use-cases/run.sh b/cedar-example-use-cases/run.sh
@@ -2,15 +2,15 @@
 
 source ../test_utils.sh
 
-# PhotoApp
+# GitHub
 echo -e "\nTesting github_example..."
-validate "github_example" "policies.cedar" "github_example.cedarschema"
+validate "github_example" "policies.cedar" "policies.cedarschema"
 authorize "github_example" "policies.cedar" "entities.json"
 format "github_example" "policies.cedar"
 
-# GitApp
+# Document cloud
 echo -e "\nTesting document_cloud..."
-validate "document_cloud" "policies.cedar" "document_cloud.cedarschema"
+validate "document_cloud" "policies.cedar" "policies.cedarschema"
 authorize "document_cloud" "policies.cedar" "entities.json"
 format "document_cloud" "policies.cedar"