Skip to content

Commit

Permalink
Docs publishing workflow fixes (#16)
Browse files Browse the repository at this point in the history
  • Loading branch information
nirinchev authored Aug 2, 2023
1 parent 23d1347 commit 43dd2d4
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/publish-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,10 @@ jobs:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
permissions:
contents: read
pages: write
id-token: write
runs-on: ubuntu-latest
needs: [ main ]
steps:
Expand Down
8 changes: 4 additions & 4 deletions Docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ The Realm.LFS package is available on NuGet. To install it, run the following co
dotnet add package Realm.LFS
```

It provides the basic building blocks for working with binary data. In addition to it, there are 3 packages that provide an implementation for the `RemoteFileManager`:
It provides the basic building blocks for working with binary data. In addition to it, there are 3 packages that provide an implementation for the `RemoteStorageManager`:

1. [`Realm.LFS.Functions`](https://www.nuget.org/packages/Realm.LFS.Functions) provides a file manager that calls an Atlas Function to obtain a pre-signed url. Then it uploads data to the retried url.
2. [`Realm.LFS.S3`](https://www.nuget.org/packages/Realm.LFS.S3) uses the S3 SDK to upload files to an S3 bucket.
3. [`Realm.LFS.Azure`](https://www.nuget.org/packages/Realm.LFS.Azure) uses the Azure SDK to upload files to Azure Blob Storage.

If you use another service or have your own web server that can process the file uploads, you need to supply your own implementation of `RemoteFileManager`.
If you use another service or have your own web server that can process the file uploads, you need to supply your own implementation of `RemoteStorageManager`.

## Usage

Expand All @@ -42,9 +42,9 @@ public class Recipe : RealmObject
To initialize the SDK, the minimum configuration you need to do is to configure the remote manager factory:

```csharp
FileManager.Initialize(new FileManagerOptions
LFSManager.Initialize(new LFSOptions
{
RemoteManagerFactory = (config) => new FunctionsFileManager(config, "MyDataFunction")
RemoteManagerFactory = (config) => new AtlasFunctionsStorageManager(config, "MyDataFunction")
});
```

Expand Down

0 comments on commit 43dd2d4

Please sign in to comment.