chore: added readme and renamed folder

openfga · Nov 15, 2024 · f66230b · f66230b
1 parent d257886
commit f66230b
Show file tree

Hide file tree

Showing 11 changed files with 12 additions and 0 deletions.
diff --git a/stores/modeling-guide/README.md b/stores/modeling-guide/README.md
@@ -0,0 +1,12 @@
+# OpenFGA Modeling Guide
+
+This folder includes a sequence of models that start from a basic document&documents model, starts adding features on top of it.
+
+Each step is covered in the [OpenFGA Model Guides](https://www.youtube.com/playlist?list=PLUR5l-oTFZqWaDdhEOVt_IfPOIbKo1Ypt) Youtube playlist.
+
+## Try It Out
+
+1. Make sure you have the [FGA CLI](https://github.com/openfga/cli/?tab=readme-ov-file#installation)
+
+2. In the `modeling-guide` directory, run `fga model test --tests step-1-basic.fga.yaml` for any example you can to test.
+
diff --git a/stores/public-demo/step-1-basic.fga.yaml → stores/modeling-guide/step-1-basic.fga.yaml b/stores/public-demo/step-1-basic.fga.yaml → stores/modeling-guide/step-1-basic.fga.yaml
diff --git a/.../step-10-fine-grained-api-access.fga.yaml → .../step-10-fine-grained-api-access.fga.yaml b/.../step-10-fine-grained-api-access.fga.yaml → .../step-10-fine-grained-api-access.fga.yaml
diff --git a/...public-demo/step-2-multi-tenancy.fga.yaml → ...eling-guide/step-2-multi-tenancy.fga.yaml b/...public-demo/step-2-multi-tenancy.fga.yaml → ...eling-guide/step-2-multi-tenancy.fga.yaml
diff --git a/stores/public-demo/step-3-groups.fga.yaml → stores/modeling-guide/step-3-groups.fga.yaml b/stores/public-demo/step-3-groups.fga.yaml → stores/modeling-guide/step-3-groups.fga.yaml
diff --git a/...public-demo/step-4-public-access.fga.yaml → ...eling-guide/step-4-public-access.fga.yaml b/...public-demo/step-4-public-access.fga.yaml → ...eling-guide/step-4-public-access.fga.yaml
diff --git a/...-demo/step-5-relation-based-abac.fga.yaml → ...guide/step-5-relation-based-abac.fga.yaml b/...-demo/step-5-relation-based-abac.fga.yaml → ...guide/step-5-relation-based-abac.fga.yaml
diff --git a/...s/public-demo/step-6-super-admin.fga.yaml → ...odeling-guide/step-6-super-admin.fga.yaml b/...s/public-demo/step-6-super-admin.fga.yaml → ...odeling-guide/step-6-super-admin.fga.yaml
diff --git a/...7-conditional-relationships-abac.fga.yaml → ...7-conditional-relationships-abac.fga.yaml b/...7-conditional-relationships-abac.fga.yaml → ...7-conditional-relationships-abac.fga.yaml
diff --git a/.../public-demo/step-8-custom-roles.fga.yaml → ...deling-guide/step-8-custom-roles.fga.yaml b/.../public-demo/step-8-custom-roles.fga.yaml → ...deling-guide/step-8-custom-roles.fga.yaml
diff --git a/...c-demo/step-9-application-access.fga.yaml → ...-guide/step-9-application-access.fga.yaml b/...c-demo/step-9-application-access.fga.yaml → ...-guide/step-9-application-access.fga.yaml