Skip to content

Commit 5774513

Browse files
authored
chore: fix typos across all docs
chore: fix typos across all docs
2 parents 712cc35 + 38e265a commit 5774513

32 files changed

+104
-104
lines changed

docs/api-reference/bundle/write-bundle.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ Prior to Data Bundles, it was the responsibility of the services (such as [Write
1111

1212
With the Data Bundles, you be able to bundle and model the creation and deletion of relations and attributes when specific actions occur on resources in your applications.
1313

14-
We believe this functionality will streamline managing authorization data as well as managing this in a central place increase visibility around certain actions/triggers that end up with data creation.
14+
We believe this functionality will streamline managing authorization data as well as managing this in a central place increases visibility around certain actions/triggers that end up with data creation.
1515

16-
## How Bundles Works
16+
## How Bundles Work
1717

18-
Let's examine how Bundles operates with basic example.
18+
Let's examine how Bundles operate with a basic example.
1919

20-
Let's say you want to model how data will be created when an organization created in your application. For this purpose, you can utilize the WriteBundle API endpoint. This API enables users to define or update data bundles, each distinguished by a unique name.
20+
Let's say you want to model how data will be created when an organization is created in your application. For this purpose, you can utilize the WriteBundle API endpoint. This API enables users to define or update data bundles, each distinguished by a unique name.
2121

2222
Here's an example body for WriteBundle in this scenario:
2323

docs/api-reference/introduction.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ We structured Permify API in 4 core parts:
1010
- [PermissionService]: Consists access control requests and options.
1111
- [DataService]: Authorization data operations such as creating, deleting and reading relational tuples.
1212
- [SchemaService]: Modeling and Permify Schema related functionalities including configuration and auditing.
13-
- [TenancyService]: Consists tenant operations such as creating, deleting and listing.
13+
- [TenancyService]: Consists of tenant operations such as creating, deleting and listing.
1414
- [BundleService]: Manages bundled creation and deletion of relations and attributes to keep authorization data aligned with the business model.
1515

1616
Permify exposes its APIs via both [gRPC](https://buf.build/permifyco/permify/docs/main:base.v1) and [REST](https://restfulapi.net/).
@@ -56,13 +56,13 @@ However, since it communicates using standard protocols like gRPC and HTTP, it i
5656

5757
You can secure APIs with our authentication methods; **Open ID Connect** or **Pre Shared Keys**. They can be configurable with flags or using configuration yaml file. See more details how to enable authentication from [Configuration Options](../../setting-up/configuration)
5858

59-
To access the endpoints after enabling authentication, it's necessary to provide a Bearer Token for identification. If your using golang or nodeJs client library, an authentication token can be provided via interceptors. You can find details in the clients' documentation.
59+
To access the endpoints after enabling authentication, it's necessary to provide a Bearer Token for identification. If you're using Golang or Node.js client library, an authentication token can be provided via interceptors. You can find details in the clients' documentation.
6060

6161
## Latency & Performance
6262

6363
With the right architecture we expect **7-12 ms** latency. Depending on your load, cache usage and architecture you can get up to **30ms**.
6464

65-
Permify implements several cache mechanisms in order to achieve low latency in scaled distributed systems. See more on the section [Cache Mechanisims](../../operations/cache)
65+
Permify implements several cache mechanisms in order to achieve low latency in scaled distributed systems. See more on the section [Cache Mechanisms](../../operations/cache)
6666

6767
## Availability of the Service
6868

@@ -89,6 +89,6 @@ These credits are your sole remedy for any availability failures under our SLA.
8989

9090
Default rate limit is set to 100 requests per second. However, users can adjust this based on their specific needs following our [documentation](https://docs.permify.co/docs/reference/configuration). We used [Token bucket](https://en.wikipedia.org/wiki/Token_bucket) algorithm for rate limiting.
9191

92-
## Need any help ?
92+
## Need any help?
9393

9494
Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a consultation call with one of our account executives](https://www.permify.co/book-demo).

docs/cloud/intro.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ What you can find in this tab:
6363

6464
## Schema Management
6565

66-
It’s expected that your initial schema will eventually change as your products evolves.
66+
It’s expected that your initial schema will eventually change as your product evolves.
6767

6868
As new features, API endpoints, user requirements or compliance requirements are regularly rolled out, each addition often necessitates corresponding updates to your authorization model, [Permify Schema](../getting-started/modeling).
6969

@@ -77,7 +77,7 @@ The **Schemas** view lists the latest configured schemas with the [WriteSchema A
7777

7878
### Schema Deployments
7979

80-
One of the best practise to manage schema changes is setting up a central git repository that stores the schema YAML file.
80+
Managing schema changes by setting up a central git repository that stores the schema YAML file is a best practice.
8181

8282
This way, you can centrally check and approve every schema change before deploying it.
8383

@@ -91,7 +91,7 @@ In Permify Cloud we even streamline this management process for you with connect
9191

9292
With **Schema Management GitOps Workflow**, you can now automatically deploy authorization models to Permify directly from your GitHub repository.
9393

94-
Similar deploying your Vercel application with GitHub Actions. And we show these deployments in the **Deployments** view.
94+
Similar to deploying your Vercel application with GitHub Actions. And we show these deployments in the **Deployments** view.
9595

9696
### How Schema Deployment Works ?
9797

@@ -155,7 +155,7 @@ If all tests pass, the model is seamlessly deployed to Permify, and you can moni
155155

156156
### Schema Staging
157157

158-
In above example we directly pushed our change to master branch. And this deployment records labeled as **production** by default.
158+
In the above example we directly pushed our change to the master branch. And this deployment record is labeled as **production** by default.
159159

160160
If you have at least a couple of engineers who can make schema changes, you will want to have a review process for these changes.
161161

@@ -227,7 +227,7 @@ To learn more how it works and how to configure it, see the [Schema Management](
227227

228228
The **Garbage Collector** is a mechanism designed to clean up expired or idle relation tuples.
229229

230-
This is particularly important when schemas are changed or created frequently, as it can lead to the creation of many unused tuples within time.
230+
This is particularly important when schemas are changed or created frequently, as it can lead to the creation of many unused tuples over time.
231231

232232
![garbage-collector](https://github.com/user-attachments/assets/0b5537a3-d6e3-4ae3-b016-19fbff5c1b7f)
233233

@@ -241,7 +241,7 @@ Autoscaling is by default activated in Permify Cloud.
241241

242242
![auto-scaling](https://github.com/user-attachments/assets/2805dc21-eb3f-457e-8ad4-225f5aaa1653)
243243

244-
It automatically adjust resource allocation to meet demand, ensuring optimal performance and cost-efficiency.
244+
It automatically adjusts resource allocation to meet demand, ensuring optimal performance and cost-efficiency.
245245

246246
### Consistent Hashing
247247

docs/development.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ yarn global add mintlify
2222

2323
</CodeGroup>
2424

25-
Step 2. Go to the docs are located (where you can find `mint.json`) and run the following command:
25+
Step 2. Go to where the docs are located (where you can find `mint.json`) and run the following command:
2626

2727
```bash
2828
mintlify dev

docs/getting-started/enforcement.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,13 +54,13 @@ However, since it communicates using standard protocols like gRPC and HTTP, it i
5454

5555
You can secure APIs with our authentication methods; **Open ID Connect** or **Pre Shared Keys**. They can be configurable with flags or using configuration yaml file. See more details how to enable authentication from [Configuration Options](../../setting-up/configuration)
5656

57-
To access the endpoints after enabling authentication, it's necessary to provide a Bearer Token for identification. If your using golang or nodeJs client library, an authentication token can be provided via interceptors. You can find details in the clients' documentation.
57+
To access the endpoints after enabling authentication, it's necessary to provide a Bearer Token for identification. If you're using the Golang or Node.js client library, an authentication token can be provided via interceptors. You can find details in the clients' documentation.
5858

5959
## Latency & Performance
6060

6161
With the right architecture we expect **7-12 ms** latency. Depending on your load, cache usage and architecture you can get up to **30ms**.
6262

63-
Permify implements several cache mechanisms in order to achieve low latency in scaled distributed systems. See more on the section [Cache Mechanisims](../../operations/cache)
63+
Permify implements several cache mechanisms in order to achieve low latency in scaled distributed systems. See more on the section [Cache Mechanisms](../../operations/cache)
6464

6565
## Availability of the Service
6666

@@ -87,6 +87,6 @@ These credits are your sole remedy for any availability failures under our SLA.
8787

8888
Default rate limit is set to 100 requests per second. However, users can adjust this based on their specific needs following our [documentation](https://docs.permify.co/docs/reference/configuration). We used [Token bucket](https://en.wikipedia.org/wiki/Token_bucket) algorithm for rate limiting.
8989

90-
## Need any help ?
90+
## Need any help?
9191

9292
Our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about this example, [schedule a consultation call with one of our account executives](https://www.permify.co/book-demo).

docs/getting-started/examples/facebook-groups.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -533,8 +533,8 @@ The validation result according to our example schema validation file:
533533

534534
![Screen Shot 2023-04-16 at 15 53 06](https://user-images.githubusercontent.com/34595361/233152003-1fbaf2af-d208-4290-af1f-359870b0de49.png)
535535

536-
## Need any help ?
536+
## Need any help?
537537

538-
This is the end of demonstration of the authorization structure for Facebook groups. To install and implement this see the [Set Up Permify](../../installation.md) section.
538+
This concludes the demonstration of the authorization structure for Facebook groups. To install and implement this see the [Set Up Permify](../../installation.md) section.
539539

540-
If you need any kind of help, our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about it, [schedule a consultation call with one of our account executives](https://www.permify.co/book-demo).
540+
If you need any kind of help, our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about it, [schedule a consultation call with one of our account executives](https://www.permify.co/book-demo).

docs/getting-started/examples/google-docs.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ entity document {
4545
entity user {}
4646
```
4747

48-
Represents a user who can be granted permission to access a documents directly, or through their membership in a group or organization.
48+
Represents a user who can be granted permission to access documents directly, or through their membership in a group or organization.
4949

5050
### Document
5151

@@ -190,7 +190,7 @@ Finally, let's check some permissions and test our authorization logic.
190190
}
191191
```
192192

193-
According what we have defined for the edit action managers and admins, of the organization that document belongs, can edit product database. In this context, Permify engine will check does subject `user:ashley` has any direct or indirect manager relation within `document:product_database`. Consecutively it will check does `user:ashley` has admin relation in the Acme Org - `organization:acme#document@document:product_database`.
193+
According to what we have defined for the edit action, managers and admins of the organization that the document belongs to can edit the product database. In this context, Permify engine will check whether the subject `user:ashley` has any direct or indirect manager relation within `document:product_database`. Consecutively it will check whether `user:ashley` has admin relation in the Acme Org - `organization:acme#document@document:product_database`.
194194

195195
Ashley doesn't have any administrative relation in Acme Org but she is the manager in group tech (`group:tech#manager@user:ashley`) and we have defined that manager of group tech is manager of product_database with the tuple (`document:product_database#manager@group:tech#manager`). Therefore, the **user:ashley edit document:product_database** check request should yield **true** response.
196196
</Accordion>
@@ -208,7 +208,7 @@ entity document {
208208
}
209209
```
210210

211-
According what we have defined for the view action viewers or managers or org.admin's can view hr documents. In this context, Permify engine will check whether subject `user:joe` has any direct or indirect manager or viewer relation within `document:hr_documents`. Also consecutively it will check does `user:joe` has admin relation in the Acme Org - `organization:acme#document@document:hr_documents`.
211+
According to what we have defined for the view action, viewers, managers, or org.admin's can view HR documents. In this context, Permify engine will check whether subject `user:joe` has any direct or indirect manager or viewer relation within `document:hr_documents`. Also consecutively it will check whether `user:joe` has admin relation in the Acme Org - `organization:acme#document@document:hr_documents`.
212212

213213
Joe doesn't have administrative role/relation in Acme Org.
214214

@@ -230,7 +230,7 @@ entity document {
230230
}
231231
```
232232

233-
According what we have defined for the view action viewers or managers or org.admin's can view hr documents. In this context, Permify engine will check does subject `user:david` has any direct or indirect manager or viewer relation within `document:marketing_materials`. Also consecutively it will check does `user:david` has admin relation in the Acme Org - `organization:acme#document@document:marketing_materials`.
233+
According to what we have defined for the view action, viewers, managers, or org.admin's can view HR documents. In this context, Permify engine will check whether subject `user:david` has any direct or indirect manager or viewer relation within `document:marketing_materials`. Also consecutively it will check whether `user:david` has admin relation in the Acme Org - `organization:acme#document@document:marketing_materials`.
234234

235235
Similar Joe and Ashley, David also doesn't have administrative role/relation in Acme Org.
236236

docs/getting-started/examples/instagram.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,6 +323,6 @@ The validation result according to our example schema validation file:
323323

324324
![test-result](https://github.com/Permify/permify/assets/48759364/2fb9a1ab-40d4-48e0-857a-3d59de575134)
325325

326-
## Need any help ?
326+
## Need any help?
327327

328-
This is the end of demonstration of the authorization structure for Facebook groups. To install and implement this see the [Set Up Permify](../../installation.md) section.
328+
This is the end of the demonstration of the authorization structure for Instagram. To install and implement this see the [Set Up Permify](../../installation.md) section.

docs/getting-started/examples/mercury.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ But today we’re going to focus on approvals. Mercury allows it’s users to se
1010

1111
For instance, an admin can decide that withdrawals above $1000 by members require approval from two designated approvers.
1212

13-
This means, if a member wants to withdraw more than $1000, they need a green light from two admin. And if an admin tries to withdraw they need an approval form another admin.
13+
This means, if a member wants to withdraw more than $1000, they need a green light from two admins. And if an admin tries to withdraw they need approval from another admin.
1414

1515
- Admin → Withdraw $1000 → needs an approver
1616
- Member → Withdraw $1000 → needs 2 approvers.
@@ -156,6 +156,6 @@ At last, as you can see we use the Rules to define access rights to withdraw whi
156156
- Check if user is admin, and have approval more than the approval limit for admins.
157157
- Check if user is member, and have approval more than the approval limit for members.
158158

159-
## Need any help ?
159+
## Need any help?
160160

161-
This is the end of demonstration of the authorization structure for Facebook groups. To install and implement this see the [Set Up Permify](../../installation.md) section.
161+
This is the end of the demonstration of the authorization structure for Mercury. To install and implement this see the [Set Up Permify](../../installation.md) section.

docs/getting-started/examples/notion.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -536,8 +536,8 @@ The validation result according to our example schema validation file:
536536

537537
![Screen Shot 2023-04-16 at 15 53 06](https://user-images.githubusercontent.com/34595361/233154924-c31a76f4-86f5-4ed3-a1ec-750b642927e6.png)
538538

539-
## Need any help ?
539+
## Need any help?
540540

541-
This is the end of demonstration of the authorization structure for Facebook groups. To install and implement this see the [Set Up Permify](../../installation.md) section.
541+
This is the end of the demonstration of the authorization structure for Notion. To install and implement this see the [Set Up Permify](../../installation.md) section.
542542

543543
If you need any kind of help, our team is happy to help you get started with Permify. If you'd like to learn more about using Permify in your app or have any questions about it, [schedule a consultation call with one of our account executives](https://www.permify.co/book-demo).

0 commit comments

Comments
 (0)