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.

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

Add react-helmet for page specific metadata #187

Merged
merged 4 commits into from
Jan 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/guides/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -532,6 +532,6 @@ And that's it! We now have a fully working permissions system:

## Get started for real

Want to get started for real? [Start protecting your first application](/docs/guides/first-app) or [Visit the Discord](https://discord.com/invite/jTysUaxXzM) if you have any questions!
Want to get started for real? [Start protecting your first application](./first-app.mdx) or [Visit the Discord](https://discord.com/invite/jTysUaxXzM) if you have any questions!

[authzed playground]: https://play.authzed.com
6 changes: 3 additions & 3 deletions docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ summary: "Documentation for Authzed, the planet-scale, serverless database platf
!['Relationships'](/graph.svg)

<div class="overview-top-buttons">
<a href="/docs/spicedb/operator" class="btn">
<a href="spicedb/operator" class="btn">
<i class="fa-solid fa-cubes"></i>
Install the Operator
</a>
<a href="/docs/guides/first-app" class="btn with-left-margin">
<a href="guides/first-app" class="btn with-left-margin">
<i class="fa fa-play"></i>
Get Started Protecting Your App
</a>
Expand Down Expand Up @@ -46,7 +46,7 @@ SpiceDB acts as a centralized service that stores authorization data: Once store
Log into the [Authzed dashboard] to create a serverless SpiceDB instance or [run SpiceDB] yourself, and then:

<div class="next-steps-grid">
<a href="/docs/guides/first-app">
<a href="guides/first-app">
<Button class="btn btn-large">
<i class="fa fa-play"></i>
Start Protecting Your App
Expand Down
2 changes: 1 addition & 1 deletion docs/spicedb-enterprise/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ You can license SpiceDB Enterprise to deploy into your own environment.

SpiceDB Enterprise comes with:

* [Fine-Grained Access Management tokens for your service accounts](/docs/spicedb-enterprise/fgam)
* [Fine-Grained Access Management tokens for your service accounts](./fgam.md)
* Full SpiceDB request audit logging
* Early access to security patches
* Additional enterprise-only functionality as it's released
Expand Down
2 changes: 1 addition & 1 deletion docs/spicedb/deploy-on-eks.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Deploy SpiceDB on EKS

This guide will show you how to deploy a highly available and secure SpiceDB cluster on EKS. If you’d rather quickly try out SpiceDB, check out our [getting started guide](/docs/guides/first-app).
This guide will show you how to deploy a highly available and secure SpiceDB cluster on EKS. If you’d rather quickly try out SpiceDB, check out our [getting started guide](../guides/first-app.mdx).

## Prerequisites

Expand Down
4 changes: 2 additions & 2 deletions docs/spicedb/load_test.md → docs/spicedb/load-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Here is an illustration of how SpiceDB walks the graph in our example:
Subproblems are computed in parallel.
:::

The concept of computing subproblems for intermediary objects, like we did for groups, is referred to as “fanning out” or “fanout”. If more groups were related, to `somedocument`, it’s likely that more subproblems will be calculated to determine `view` permission; however, the query will stop calculating subproblems (”short circuit”) if it positively satisfies the permission check before all paths are exhausted ([intersections](/docs/reference/schema-lang#-intersection) `&` and [exclusions](/docs/reference/schema-lang#--exclusion) `-` are the exception to this).
The concept of computing subproblems for intermediary objects, like we did for groups, is referred to as “fanning out” or “fanout”. If more groups were related, to `somedocument`, it’s likely that more subproblems will be calculated to determine `view` permission; however, the query will stop calculating subproblems (”short circuit”) if it positively satisfies the permission check before all paths are exhausted ([intersections](../reference/schema-lang#-intersection) `&` and [exclusions](../reference/schema-lang#--exclusion) `-` are the exception to this).

While fanout is almost always unavoidable, fanout can result in an exponential increase to the the number of subproblems that must be computed, therefore, when performing a load test it’s critical to make requests to a SpiceDB instance that is seeded with relationship data that closely mimics real world data.

Expand Down Expand Up @@ -183,7 +183,7 @@ The SpiceDB quantization interval setting is used to specify the window of time

### Consistency

Consistency has a significant effect on cache utilization and thus performance. Cache utilization is specified on a per request basis. Before conducting a load test, it’s important you understand the performance and staleness implications of the consistency message(s) you are using. The majority of SpiceDB users are using `minimize_latency` for every request. The Authzed team almost always recommends against `fully_consistent`, in lieu of `fully_consistent` we recommend using `at_least_as_fresh` so that you can utilize the cache when it’s safe to do so. You can read more about consistency [here](/docs/reference/api-consistency).
Consistency has a significant effect on cache utilization and thus performance. Cache utilization is specified on a per request basis. Before conducting a load test, it’s important you understand the performance and staleness implications of the consistency message(s) you are using. The majority of SpiceDB users are using `minimize_latency` for every request. The Authzed team almost always recommends against `fully_consistent`, in lieu of `fully_consistent` we recommend using `at_least_as_fresh` so that you can utilize the cache when it’s safe to do so. You can read more about consistency [here](../reference/api-consistency).

## Load Generation Tooling

Expand Down
Loading
Loading