Skip to content

Commit f9c65d4

Browse files
authored
chore: fix grammar errors in documentation (#393)
- Fix spelling errors (documented, absence, analysis, hierarchies, homage) - Fix missing articles and auxiliary verbs - Remove duplicate words - Fix subject-verb agreement - Correct markdown formatting
1 parent 280584a commit f9c65d4

File tree

12 files changed

+16
-16
lines changed

12 files changed

+16
-16
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ All bugs and mistakes are considered very seriously, regardless of complexity.
1818
Before creating an issue, please check that an issue reporting the same problem does not already exist.
1919
To make the issue accurate and easy to understand, please try to create issues that are:
2020

21-
- Unique -- do not duplicate existing bug report.
21+
- Unique -- do not duplicate an existing bug report.
2222
Duplicate bug reports will be closed.
2323
- Specific -- include as much details as possible: which version, what environment, what configuration, etc.
2424
- Reproducible -- include the steps to reproduce the problem.
@@ -63,6 +63,6 @@ Signed-off-by: Random J Developer <[email protected]>
6363
```
6464

6565
This can be done by using the `--signoff` (or `-s` for short) git flag to append this automatically to your commit message.
66-
If you have already authored a commit that is missing the signed-off, you can amend or rebase your commits and force push them to GitHub.
66+
If you have already authored a commit that is missing the signed-off-by, you can amend or rebase your commits and force push them to GitHub.
6767

6868
[DCO]: /DCO

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,4 @@ Run linters:
4242

4343
```sh
4444
pnpm run lint
45-
````
45+
```

pages/authzed/concepts/authzed-materialize.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ In summary, AuthZed Materialize allows you to:
3939

4040
## Client SDK
4141

42-
All SpiceDB SDKs have the generated gRPC and protobuf coded
42+
All SpiceDB SDKs have the generated gRPC and protobuf code
4343

4444
- [authzed-go v0.15.0](https://github.com/authzed/authzed-go/releases/tag/v0.15.0)
4545
- [authzed-java 0.10.0](https://github.com/authzed/authzed-java/releases/tag/0.10.0)

pages/authzed/concepts/expedited-support.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Non-critical support is prioritized through [support.authzed.com][support] or [s
3737

3838
### Emergency
3939

40-
For those that do not need all of the features of Gold Support, but do need response time SLAs for taking their services to production, we offer our Emergency plan.
40+
For those who do not need all of the features of Gold Support, but do need response time SLAs for taking their services to production, we offer our Emergency plan.
4141
This plan only includes those Response Time SLAs for critical and non-critical issues.
4242

4343
Private communication channels are provided for critical support that are integrated with the AuthZed engineering on-call.

pages/authzed/concepts/security-embargo.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ You can find a listing of public vulnerabilities for SpiceDB on [GitHub], [NVD],
2222
A security embargo program is a defined process under which security issues are privately reported, analyzed for applicability, notice is given, and a resolution is created and distributed.
2323
The issue is only made public once those affected in the embargo program have enough time to address the issue or have accepted the risks.
2424

25-
Security embargos are an industry best practice for ensuring that there are not critical software deployments with well documentated exploitation instructions.
25+
Security embargos are an industry best practice for ensuring that there are not critical software deployments with well documented exploitation instructions.
2626

2727
## Reporting a security issue
2828

@@ -58,7 +58,7 @@ When vulnerabilities are reported, AuthZed works with the reporter to develop a
5858
Some vulnerabilities are reported by research firms that have strict policies to encourage a quick response and other reports are from individuals that may be more flexible with resolution time.
5959

6060
Once a report has been verified and a timeline has been established, AuthZed customers are informed.
61-
In the absense of a strict deadline, vulnerabilities are made public once every possibly affected AuthZed customer has either resolved the issue or accepted the risk to continuing to operate.
61+
In the absence of a strict deadline, vulnerabilities are made public once every possibly affected AuthZed customer has either resolved the issue or accepted the risk to continuing to operate.
6262

6363
## What actions must users under embargo take?
6464

pages/authzed/concepts/update-channels.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Update Channels dictate the flow of updates to running SpiceDB clusters.
44

55
All channels offer a trade-off between feature availability and update churn.
6-
While each channel has a different qualification standards, all channels offer fully tested GA releases of SpiceDB.
6+
While each channel has different qualification standards, all channels offer fully tested GA releases of SpiceDB.
77

88
While open source users of the [SpiceDB Operator] have a single update channel of open source releases, AuthZed maintains two configurable channels:
99

pages/spicedb/concepts/consistency.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ If a fixed-width column is preferred, we recommend `varchar(1024)`.
151151
[ccc-api]: https://authzed.com/zanzibar#annotations/intro/content-change-check
152152
</Callout>
153153

154-
Data can be complex and designed with hierachies in mind.
154+
Data can be complex and designed with hierarchies in mind.
155155
In these scenarios, the parent resource must be referenced.
156156

157157
A simpler alternative is to perform read-after-write queries to SpiceDB with full consistency.

pages/spicedb/concepts/zanzibar.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This paper documented the design and success of the project that went on to hand
2323
Before landing on the name Zanzibar, the project was internally referred to as "Spice".
2424
At Google, their mission was to ensure the "ACLs must flow", a reference to ["the spice must flow"][spice-must-flow].
2525
This theme was chosen because Lea Kissner, one of the co-creators, is a [Dune fan][lea-dune].
26-
In homeage, AuthZed maintained a Dune-related naming scheme for their own projects.
26+
In homage, AuthZed maintained a Dune-related naming scheme for their own projects.
2727

2828
[lea-dune]: https://twitter.com/LeaKissner/status/1304457030044794880
2929
[spice-must-flow]: https://fictionhorizon.com/the-meaning-of-dunes-the-spice-must-flow-quote/

pages/spicedb/getting-started/coming-from/cancancan.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ import SpiceDBDark from '@/public/images/ps-spicedb-dark.svg'
1111
This document is designed to cover the conceptual differences between SpiceDB and the popular Ruby on Rails gem CanCanCan.
1212

1313
<Callout type="info" emoji="ℹ️">
14-
The focus of the content below is not intended to be a competitive anlaysis, but rather a bridge to understand SpiceDB for existing Rails users.
14+
The focus of the content below is not intended to be a competitive analysis, but rather a bridge to understand SpiceDB for existing Rails users.
1515
</Callout>
1616

1717
## SpiceDB vs CanCanCan
1818

1919
Every complete permissions system is made up of three major components: *models*, *data*, and an *engine*.
2020

21-
While comparing SpiceDB and CanCanCan is akin to comparing apples and oranges because they are fundamentally two different approaches, both can analyzed through the lens of these three components to understand the design of each.
21+
While comparing SpiceDB and CanCanCan is akin to comparing apples and oranges because they are fundamentally two different approaches, both can be analyzed through the lens of these three components to understand the design of each.
2222

2323
A quick recap on the components and their purpose:
2424

pages/spicedb/getting-started/coming-from/opa.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ import SpiceDBDark from '@/public/images/ps-spicedb-dark.svg'
1111
This document is designed to cover the conceptual differences between SpiceDB and Open Policy Agent (OPA).
1212

1313
<Callout type="info" emoji="ℹ️">
14-
The focus of the content below is not intended to be a competitive anlaysis, but rather a bridge to understand SpiceDB for existing OPA users.
14+
The focus of the content below is not intended to be a competitive analysis, but rather a bridge to understand SpiceDB for existing OPA users.
1515
</Callout>
1616

1717
## SpiceDB vs OPA
1818

1919
Every complete permissions system is made up of three major components: *models*, *data*, and an *engine*.
2020

21-
While comparing SpiceDB and OPA is akin to comparing apples and oranges because they are fundamentally two different approaches, both can analyzed through the lens of these three components to understand the design of each.
21+
While comparing SpiceDB and OPA is akin to comparing apples and oranges because they are fundamentally two different approaches, both can be analyzed through the lens of these three components to understand the design of each.
2222

2323
A quick recap on the components and their purpose:
2424

0 commit comments

Comments
 (0)