Skip to content

Commit 2a92d42

Browse files
committed
feat: add spellcheck CI with typo fixes
1 parent f052315 commit 2a92d42

File tree

16 files changed

+721
-17
lines changed

16 files changed

+721
-17
lines changed

.github/workflows/spellcheck.yaml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: "Spellcheck"
3+
on:
4+
push:
5+
branches:
6+
- "main"
7+
paths:
8+
- "**/*.md"
9+
- "**/*.mdx"
10+
- "spellcheck.yaml"
11+
- "wordlist.txt"
12+
pull_request:
13+
paths:
14+
- "**/*.md"
15+
- "**/*.mdx"
16+
- "spellcheck.yaml"
17+
- "wordlist.txt"
18+
19+
jobs:
20+
spellcheck:
21+
name: "Spellcheck"
22+
runs-on: "ubuntu-latest"
23+
steps:
24+
- uses: "actions/checkout@v4"
25+
- uses: "rojopolis/spellcheck-github-actions@dbd2f1da869c05ad874fffeb6fe1ed50cd1a6e98" # v0.36.0
26+
name: "Spellcheck"
27+
with:
28+
config_path: "spellcheck.yaml"

pages/authzed/concepts/authzed-materialize.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ In summary, AuthZed Materialize allows you to:
1717
- Speed up `CheckPermission` and `CheckBulkPermissions`.
1818
- Speed up `LookupResources` and `LookupSubjects`, especially when there is a large number of resources.
1919
- Build authorization-aware UIs, e.g. by providing a filtered and/or sorted list of more than several thousand authorized objects.
20-
- Perform ACL filtering in other secondary indexes, like a search index (e.g. ElasticSearch).
20+
- Perform ACL filtering in other secondary indexes, like a search index (e.g. Elasticsearch).
2121

2222
[Dedicated]: ../guides/picking-a-product#dedicated
2323

@@ -273,7 +273,7 @@ SELECT d.id FROM documents d
273273

274274
This is an update stream of all the permissions Materialize is configured to watch.
275275
You can use this to store all permissions tracked in the system closer to your application database to be used in database-native ACL filtering.
276-
Permissions can also be stored in secondary indexes like ElasticSearch.
276+
Permissions can also be stored in secondary indexes like Elasticsearch.
277277

278278
The API consists of various event types that capture deltas that occurred since a client started listening.
279279
It will also notify of events like a [breaking schema change] that necessitate rebuilding of the index.

pages/authzed/concepts/restricted-api-access.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ The following variables are provided the CEL expression varying based on the req
9292

9393
Policies are what bind Roles to a Service Account.
9494

95-
Each policy is composed of a unique identifer for the policy itself, the principal (the target of the role assignment), and any roles being assigned.
95+
Each policy is composed of a unique identifier for the policy itself, the principal (the target of the role assignment), and any roles being assigned.
9696

9797
## Task-Specific Configuration
9898

@@ -272,7 +272,7 @@ If you want to apply a configuration to an existing SpiceDB cluster without down
272272
1. You may want to start with FGAM tokens bound to a admin-like Role, since that's what the original PSKs effectively were.
273273
This is probably lower risk, and then from there you can move to start trimming down permissions.
274274
2. Or you may want to move directly to downscoped tokens for your individual services, creating the tokens you need.
275-
This may be simple if you have few clients, but more complex as the number of clients grow, and with a bigger blast radious of impact on rollout.
275+
This may be simple if you have few clients, but more complex as the number of clients grow, and with a bigger blast radius of impact on rollout.
276276
A minimal configuration would look something like:
277277

278278
```yaml

pages/spicedb/concepts/consistency.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Consistency { fully_consistent: true }
112112
A ZedToken is an opaque token representing a point-in-time of the SpiceDB datastore, encoded for easy storage and transmission.
113113
ZedTokens are used for data consistency guarantees when using the SpiceDB API.
114114

115-
ZedToken is the SpiceDB equivalant of Google Zanzibar's [Zookie] concept which protects users from the [New Enemy Problem].
115+
ZedToken is the SpiceDB equivalent of Google Zanzibar's [Zookie] concept which protects users from the [New Enemy Problem].
116116

117117
SpiceDB returns ZedTokens from the APIs that perform permission checks or modify data:
118118

pages/spicedb/concepts/datastores.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ In order to reduce operational complexity, SpiceDB leverages existing, popular s
66

77
AuthZed has standardized our managed services on CockroachDB, but we give self-hosted customers the option to pick the datastore that best suits their operational requirements.
88

9-
- [CockroachDB](#cockroachdb) - Recomended for self hosted deployments with high throughput and/or multi-region requirements
9+
- [CockroachDB](#cockroachdb) - Recommended for self hosted deployments with high throughput and/or multi-region requirements
1010
- [Cloud Spanner](#cloud-spanner) - Recommended for self-hosted Google Cloud deployments
1111
- [PostgreSQL](#postgresql) - Recommended for self-hosted single-region deployments
1212
- [MySQL](#mysql) - Not recommended; only use if you cannot use PostgreSQL
@@ -93,7 +93,7 @@ The available strategies are:
9393
| --- | --- |
9494
| `static` (default) | All writes overlap to guarantee safety at the cost of write throughput |
9595
| `prefix` | Only writes that contain objects with same prefix overlap (e.g. `tenant1/user` and `tenant2/user` can be written in concurrently) |
96-
| `request` | Only writes with the same `io.spicedb.requestoverlapkey` header overlap enabling applications to decide on-the-fly which writes have causual dependencies. Writes without any header act the same as `insecure`. |
96+
| `request` | Only writes with the same `io.spicedb.requestoverlapkey` header overlap enabling applications to decide on-the-fly which writes have causal dependencies. Writes without any header act the same as `insecure`. |
9797
| `insecure` | No writes overlap, providing the best write throughput, but possibly leaving you vulnerable to the [New Enemy Problem] |
9898

9999
For more information, refer to the [CockroachDB datastore README][crdb-readme] or our blog post "[The One Crucial Difference Between Spanner and CockroachDB][crdb-blog]".
@@ -257,7 +257,7 @@ Because this counter is instance-specific, there are ways in which the data in t
257257
Two concrete examples are the use of `pg_dump` and `pg_restore` to transfer data between an old instance and a new instance and setting up
258258
logical replication between a previously-existing instance and a newly-created instance.
259259

260-
If you encounter this, SpiceDB can behave as though there is no schema written, because the data (including the schema) is associated with a future transaction ID and therefore isn't "visible" to Spicedb.
260+
If you encounter this, SpiceDB can behave as though there is no schema written, because the data (including the schema) is associated with a future transaction ID and therefore isn't "visible" to SpiceDB.
261261
If you run into this issue, the fix is [documented here](https://authzed.com/docs/spicedb/concepts/commands#reference-spicedb-datastore-repair)
262262

263263
### Configuration

pages/spicedb/getting-started/faq.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ SpiceDB is a database designed to be integrated into applications.
2525
There are some organizations with homegrown IT use-cases that use SpiceDB.
2626
However, for most IT use cases, this is probably more low-level than what you need.
2727

28-
We recommend looking into tools designed around specific IT workflows such as auditing ([Orca], [PrismaCloud]), goverance, access management ([Indent], [ConductorOne]).
28+
We recommend looking into tools designed around specific IT workflows such as auditing ([Orca], [PrismaCloud]), governance, access management ([Indent], [ConductorOne]).
2929

3030
[Orca]: https://orca.security/platform/cloud-security-posture-management-cspm/
3131
[PrismaCloud]: https://www.paloaltonetworks.com/prisma/cloud

pages/spicedb/getting-started/install/debian.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This document outlines how to install SpiceDB for systems running [Debian-like L
77
Every release of SpiceDB publishes `.deb` packages, [snap] packages, and tarballs for AMD64 and ARM64 Linux.
88

99
Looking for `.rpm` packages?
10-
Visit the doc on [Installing SpiceDB on RHEL/Centos][rhel]
10+
Visit the doc on [Installing SpiceDB on RHEL/CentOS][rhel]
1111

1212
[debianlike]: https://en.wikipedia.org/wiki/List_of_Linux_distributions#Debian-based
1313
[rhel]: ./rhel

pages/spicedb/modeling/developing-a-schema.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ of relations.
371371

372372
### Adding an administrator user
373373

374-
Now that we've declared that all users in `administrator` on the organization are also granted the `view` permission, let's define at least one user in our test data to be an adminstrator:
374+
Now that we've declared that all users in `administrator` on the organization are also granted the `view` permission, let's define at least one user in our test data to be an administrator:
375375

376376
```relationship filename="Test Relationships"
377377
organization:someorg#administrator@user:someadminuser

pages/spicedb/modeling/representing-users.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ If you have *multiple* authentication providers, then the recommendation is to d
3838
/** githubuser represents a user from GitHub */
3939
definition githubuser {}
4040
41-
/** gitlabuser represents a user from Gitlab */
41+
/** gitlabuser represents a user from GitLab */
4242
definition gitlabuser {}
4343
```
4444

pages/spicedb/ops/ai-agent-authorization.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This guide shows how to build a secure Retrieval-Augmented Generation (RAG) pipe
66
Authorization decisions are enforced by SpiceDB.
77
You can also get summary of only the documents the AI Agent is authorized to view.
88

9-
This guide uses OpenAI, Pinecone, Langchain, Jupyter Notebook and SpiceDB
9+
This guide uses OpenAI, Pinecone, LangChain, Jupyter Notebook and SpiceDB
1010

1111
## Setup and Prerequisites
1212

0 commit comments

Comments
 (0)