Skip to content

fix grammar#328

Merged
miparnisari merged 1 commit intomainfrom
fix-grammar
Mar 13, 2025
Merged

fix grammar#328
miparnisari merged 1 commit intomainfrom
fix-grammar

Conversation

@miparnisari
Copy link
Contributor

No description provided.

@vercel
Copy link
Contributor

vercel bot commented Mar 13, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 13, 2025 8:48pm

Copy link
Collaborator

@tstirrat15 tstirrat15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! See comment

Comment on lines +39 to +40
| --migration-backfill-batch-size | number of items to migrate per iteration of a datastore backfill (default 1000) | |
| --migration-timeout | defines a timeout for the execution of the migration, set to 1 hour by default (default 1h0m0s) | |
| --migration-backfill-batch-size | number of items to migrate per iteration of a datastore backfill | 1000 |
| --migration-timeout | defines a timeout for the execution of the migration | 1h |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are copied from the output of spicedb serve --help - I'd recommend either leaving them as-is or fixing them in the upstream as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are they copied manually every time the upstream changes or is there an automated process?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😅 I think it's a manual process and I don't know that it's been done after every release. We've got work that a community member has contributed to autogenerate docs for zed and SpiceDB in flight, but it isn't currently working. I've got it somewhere on my list to figure out...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, undid all the changes in this file.


Within a Permissions System, a [CheckPermission] call is always made between an object representing the *resource* and an object representing a *subject*: The API call returns whether the *subject* has the specified permission on the *resource*.

The choice of how to represent subjects can have large downstream effects on the design of a permissions system.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This message is repeated in line 21

@miparnisari miparnisari marked this pull request as ready for review March 13, 2025 20:50
Copy link
Collaborator

@tstirrat15 tstirrat15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Schweet

In the example below, the schema enforces the following authorization logic: a user can only view a document if the user is related to the document as viewer and editing is enabled for the document.
To enable document editing in the example below, you need to establish a wildcard relationship that connects all users to the document using the ```edit_enabled``` wildcard relation.
A user will have ```edit``` permission on the document if they are related to the document as an ```editor``` and they relate to the document through ```edit_enabled```.
In the example below, the schema enforces the following authorization logic: a user will have ```edit``` permission on the document if they are related to the document as an ```editor``` and they relate to the document through ```edit_enabled```.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've never seen inlined-triple-backtick. does it differ from single backtick?

I guess you're cribbing from what's around it 🤔

This command will also highlight which parts of the traversal were cached and if a cycle is detected.
This command will also highlight which parts of the traversal were cached and if a [cycle] is detected.

[cycle]: ./recursion-and-max-depth#recursion-in-relationships
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@miparnisari miparnisari merged commit 71340d1 into main Mar 13, 2025
9 checks passed
@miparnisari miparnisari deleted the fix-grammar branch March 13, 2025 21:17
@github-actions github-actions bot locked and limited conversation to collaborators Mar 13, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants