Bulk import documentation

[tstirrat15]

Description

We've gotten questions around this from several users and the behavior isn't entirely intuitive. This documents how bulk importing works and provides an example.

Changes

• Add documentation

Testing

Review docs. See that stuff makes sense.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview	✅ 2 resolved	Nov 20, 2024 3:26pm

[sohanmaheshwar]

Hey @tstirrat15

Some questions / comments I had:

1. Is the RetryableClient method available only for the authzed-go client or is it available for other client libraries as well? I did see the line "Similar logic can be implemented using the other client libraries.". IMHO, if the method is available for all client libraries - we can use the same client library as the example snippet for Bulk Import and for Retrying. For ex: Using authzed-dotnet or authzed-go for both.

2. Alternately, what do you think about adding examples for Bulk Import for all client libraries in a tabbed format? I see we have support in Go & Py atleast so devs could read it in their language of choice and use as needed.

Tabs that look like this:

3. Is there a place where the Skip and Touch semantics are explained in-depth? If so, we could link that just to avoid any ambiguity about that behaviour.

[sohanmaheshwar]

LGTM.

Minor nit - For the first code snippet - should we use "Csharp" or "dotnet" ? Asking as we've used dotnet in our client libraries.