Skip to content

Commit

Permalink
Merge pull request #241 from authzed/some-typos
Browse files Browse the repository at this point in the history
addres some typos
  • Loading branch information
samkim authored Aug 22, 2024
2 parents ae48706 + 3080451 commit 3ddc9e9
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
22 changes: 11 additions & 11 deletions pages/spicedb/getting-started/discovering-spicedb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ Welcome to the official documentation for the SpiceDB ecosystem.

## What is SpiceDB?

SpiceDB is an open source, [Google Zanzibar]-inspired database system for real-time, security-critical application permissions.
SpiceDB is an open-source, [Google Zanzibar]-inspired database system for real-time, security-critical application permissions.

Developers create and apply a [schema] that models their application's resources and permissions.
From their applications, [client libraries] are used to insert [relationships] or check permissions in their applications.

Building modern authorization from scratch is non-trivial and requires years of development from domain experts.
Until SpiceDB, the only developers with access to these workflows were employed by massive tech companies that could invest in building mature, but proprietary solutions.
Now we have a community organized around sharing this technology so that the entire industry can benefit.
Now we have a community organized around sharing this technology so the entire industry can benefit.

In some scenarios, SpiceDB can be challenging to operate because it is a critical, low-latency, distributed system.
For folks interested in a managed SpiceDB services and enterprise functionality, there are [AuthZed's products][authzed-products].
For folks interested in managed SpiceDB services and enterprise functionality, there are [AuthZed's products][authzed-products].

[Google Zanzibar]: https://authzed.com/blog/what-is-zanzibar/
[schema]: https://authzed.com/docs/guides/schema
Expand All @@ -41,10 +41,10 @@ For folks interested in a managed SpiceDB services and enterprise functionality,
In August 2020, the founders of AuthZed left [Red Hat], who had acquired their previous company [CoreOS].
In the following month, they would write the first API-complete implementation of Zanzibar; project Arrakis was written in lazily-evaluated, type-annotated Python.
In September, Arrakis was demoed as a part of their [YCombinator] application.
In March 2021, Arrakis was rewritten in Go, a project code-named Caladan.
In March 2021, Arrakis was rewritten in Go, a project code named Caladan.
This rewrite would eventually be open-sourced in September 2021 under the name [SpiceDB].

You can read also read the [history of Google's Zanzibar project][zanzibar-history], which is the spirtual predecessor and inspiration for SpiceDB.
You can also read the [history of Google's Zanzibar project][zanzibar-history], the spiritual predecessor and inspiration for SpiceDB.

[Red Hat]: https://redhat.com
[CoreOS]: https://www.redhat.com/en/technologies/cloud-computing/openshift/what-was-coreos
Expand All @@ -57,16 +57,16 @@ You can read also read the [history of Google's Zanzibar project][zanzibar-histo
Features that distinguish SpiceDB from other systems include:

- Expressive [gRPC] and [HTTP/JSON] APIs for checking permissions, listing access, and powering devtools
- A distributed, parallel graph-engine faithful to the architecture described in [Google's Zanzibar paper]
- A flexible consistency model configurable [per-request] that includes resistance to the [New Enemy Problem]
- A distributed, parallel graph engine faithful to the architecture described in [Google's Zanzibar paper]
- A flexible consistency model configurable [per request] that includes resistance to the [New Enemy Problem]
- An expressive [schema language] with a [playground] and CI/CD integrations for [validation] and [integration testing]
- A pluggable [storage system] supporting [in-memory], [Spanner], [CockroachDB], [PostgreSQL] and [MySQL]
- Deep observability with [Prometheus] metrics, [pprof] profiles, structured logging, and [OpenTelemetry] tracing

[gRPC]: https://buf.build/authzed/api/docs/main:authzed.api.v1
[HTTP/JSON]: https://app.swaggerhub.com/apis-docs/authzed/authzed/1.0

[per-request]: https://docs.authzed.com/reference/api-consistency
[per request]: https://docs.authzed.com/reference/api-consistency
[New Enemy Problem]: https://authzed.com/blog/new-enemies/

[schema language]: https://docs.authzed.com/guides/schema
Expand All @@ -93,7 +93,7 @@ Features that distinguish SpiceDB from other systems include:

### Dive into some videos

SpiceDB developers and community members have recorded videos explaining concepts, modeling familiar applications, and deep diving on the tech powering everything!
SpiceDB developers and community members have recorded videos explaining concepts, modeling familiar applications, and deep-diving into the tech powering everything!

<br />
<YouTube videoId="p8xh_z6PUqE" className="youtubeContainer" opts={{playerVars:{start: 228}}} />
Expand All @@ -114,7 +114,7 @@ Why not ask them a question or two?

SpiceDB and Zed run on Linux, macOS, and Windows on both AMD64 and ARM64 architectures.

Follow the instructions below install to your development machine:
Follow the instructions below to install to your development machine:

<Cards>
<Card arrow={true} icon={<FontAwesomeIcon icon={faServer} />} title="Install the SpiceDB server binary" href="/spicedb/getting-started/installing-spicedb" />
Expand All @@ -141,7 +141,7 @@ After these, we recommend these concepts for running SpiceDB:
<Card arrow={true} title="Operator" href="../concepts/operator" />
</Cards>

Finally, there are some more advanced concepts that are still fundamental:
Finally, some more advanced concepts are still fundamental:

<Cards>
<Card arrow={true} title="Consistency" href="../concepts/consistency" />
Expand Down
3 changes: 2 additions & 1 deletion pages/spicedb/modeling/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
"developing-a-schema": "Developing a Schema",
"representing-users": "Representing Users",
"validation-testing-debugging": "Validation, Testing, Debugging",
"recursion-and-max-depth": "Recursion & Max Depth"
"recursion-and-max-depth": "Recursion & Max Depth",
"protecting-a-list-endpoint": "Protecting a List Endpoint"
}

0 comments on commit 3ddc9e9

Please sign in to comment.