docs: fix example not following best practice (#582)

ory · May 11, 2021 · a015818 · a015818
1 parent 21067b1
commit a015818
Show file tree

Hide file tree

Showing 13 changed files with 21,496 additions and 107 deletions.
diff --git a/docs/docs/concepts/graph-of-relations.mdx b/docs/docs/concepts/graph-of-relations.mdx
@@ -3,8 +3,6 @@ title: The Graph of Relations
 ---
 
 import Mermaid from '@theme/Mermaid'
-import RelationTuplePrism from '@theme/RelationTuplePrism'
-RelationTuplePrism()
 
 The [relation tuples](./relation-tuples.mdx) of the ACL used by Ory Keto can be
 represented as a graph of relations. This graph will help us to understand many
@@ -35,7 +33,7 @@ readability. In practice, the namespace always has to be considered.
 // user1 has access on dir1
 dir1#access@user1
 // Have a look on the subjects concept page if you don't know the empty relation.
-dir1#parent@(file1#)
+dir1#child@(file1#)
 // Everyone with access to dir1 has access to file1. This would probably be defined
 // through a subject set rewrite that defines this inherited relation globally.
 // In this example, we define this tuple explicitly.
@@ -54,8 +52,8 @@ This is represented by the following graph:
   chart={`
 graph TD
     subgraph obj [Object region]
-    A[file1]
-    E[dir1] -->|parent| A
+    E[dir1]
+    A[file1] -->|child| E
     G[file2]
     end
     subgraph subjID [Subject ID region]

diff --git a/docs/docs/concepts/namespaces.mdx b/docs/docs/concepts/namespaces.mdx
@@ -2,9 +2,6 @@
 title: Namespaces
 ---
 
-import RelationTuplePrism from '@theme/RelationTuplePrism'
-RelationTuplePrism()
-
 Ory Keto knows the concept of namespaces to organize
 [relation tuples](./relation-tuples.mdx). Namespaces have a configuration that
 defines the relations, and some other important values

diff --git a/docs/docs/concepts/objects.mdx b/docs/docs/concepts/objects.mdx
@@ -2,9 +2,6 @@
 title: Objects
 ---
 
-import RelationTuplePrism from '@theme/RelationTuplePrism'
-RelationTuplePrism()
-
 Objects are identifiers for some kind of application objects. They can represent
 e.g. a file, network port, physical item, ... . It is up to the application to
 map its objects to an unambiguous identifier. The limit on object identifiers is

diff --git a/docs/docs/concepts/relation-tuples.mdx b/docs/docs/concepts/relation-tuples.mdx
@@ -2,9 +2,6 @@
 title: Relation Tuples
 ---
 
-import RelationTuplePrism from '@theme/RelationTuplePrism'
-RelationTuplePrism()
-
 Relation tuples are the underlying datatype of Ory Keto's access control
 language. They encode relations between [objects](./objects.mdx) and
 [subjects](./subjects.mdx). A relation tuple is associated with a

diff --git a/docs/docs/concepts/subjects.mdx b/docs/docs/concepts/subjects.mdx
@@ -2,9 +2,6 @@
 title: Subjects
 ---
 
-import RelationTuplePrism from '@theme/RelationTuplePrism'
-RelationTuplePrism()
-
 In Ory Keto subjects are a recursive polymorphic datatype. They either refer to
 a specific subject (e.g. user) by some application defined identifier, or a set
 of subjects.

diff --git a/docs/docs/examples/olymp-file-sharing.mdx b/docs/docs/examples/olymp-file-sharing.mdx
@@ -2,9 +2,6 @@
 title: 'Basic: Olymp Library'
 ---
 
-import RelationTuplePrism from '@theme/RelationTuplePrism'
-RelationTuplePrism()
-
 #### A basic, down-to-earth full feature example
 
 Consider a file sharing application called "Olymp Library". Each file is stored

diff --git a/docs/docs/guides/expand-api-display-who-has-access.mdx b/docs/docs/guides/expand-api-display-who-has-access.mdx
@@ -3,8 +3,6 @@ title: 'Expand API: Display who has Access to an Object'
 ---
 
 import CodeTabs from '@theme/CodeTabs'
-import RelationTuplePrism from '@theme/RelationTuplePrism'
-RelationTuplePrism()
 
 This guide will explain how to use Ory Keto's expand-API to display who has
 access to an object, and why. Please refer to the

diff --git a/docs/docs/guides/list-api-display-objects.mdx b/docs/docs/guides/list-api-display-objects.mdx
@@ -3,8 +3,6 @@ title: 'List API: Display all Objects a User has Access to'
 ---
 
 import CodeTabs from '@theme/CodeTabs'
-import RelationTuplePrism from '@theme/RelationTuplePrism'
-RelationTuplePrism()
 
 In this guide you will learn how to use Ory Keto's list API to display a list of
 all objects (e.g. files, ...) a user has access to. Please refer to the

diff --git a/docs/docs/guides/simple-access-check-guide.mdx b/docs/docs/guides/simple-access-check-guide.mdx
@@ -3,9 +3,7 @@ title: Check whether a User has Access to Something
 ---
 
 import Mermaid from '@theme/Mermaid'
-import RelationTuplePrism from '@theme/RelationTuplePrism'
 import CodeTabs from '@theme/CodeTabs'
-RelationTuplePrism()
 
 This guide will explain how you can use Ory Keto's
 [check-API](../concepts/api-overview.mdx#check-relation-tuple) to determine

diff --git a/docs/docs/performance.mdx b/docs/docs/performance.mdx
@@ -3,8 +3,6 @@ title: Performance
 ---
 
 import Mermaid from '@theme/Mermaid'
-import RelationTuplePrism from '@theme/RelationTuplePrism'
-RelationTuplePrism()
 
 This document explains the time complexity of Ory Keto. Main memory complexity
 will be analyzed and added at a later point. We only examine the evaluation

diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx
@@ -2,9 +2,6 @@
 title: 'Quickstart: Cat Videos Example'
 ---
 
-import RelationTuplePrism from '@theme/RelationTuplePrism'
-RelationTuplePrism()
-
 This example describes a video sharing service. The individual videos are
 organized in directories. Every directory has an owner and every video has the
 same owner as it's parent directory. The owner has elevated privileges about the