Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix example not following best practice and relation tuple syntax highlighting #582

Merged
merged 5 commits into from
May 11, 2021
Merged

docs: fix example not following best practice and relation tuple syntax highlighting #582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f5f257f
docs: fix example not following best practice and relation tuple synt…
zepatrik May 3, 2021
486044b
u
zepatrik May 4, 2021
80e5685
Merge branch 'master' into docs-improvements
zepatrik May 6, 2021
2e7d9d0
chore: remove all prism language side effect imports
zepatrik May 6, 2021
e24454b
chore: remove old RelationTuplePrism.js definiton
zepatrik May 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions docs/docs/concepts/graph-of-relations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -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]
Expand Down
3 changes: 0 additions & 3 deletions docs/docs/concepts/namespaces.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/docs/concepts/objects.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/docs/concepts/relation-tuples.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/docs/concepts/subjects.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 0 additions & 3 deletions docs/docs/examples/olymp-file-sharing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions docs/docs/guides/expand-api-display-who-has-access.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions docs/docs/guides/list-api-display-objects.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions docs/docs/guides/simple-access-check-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 0 additions & 2 deletions docs/docs/performance.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/docs/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading