Skip to content

Commit

Permalink
Update quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
criccomini committed Oct 6, 2023
1 parent c2666fd commit dab37d8
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The registry server is a simple [FastAPI](https://fastapi.tiangolo.com/) applica
The registry will work out of the box without any configuration. Schemas are stored in `$RECAP_HOME/schemas`. You can change the storage location by setting the following environment variables:

- `RECAP_REGISTRY_STORAGE_URL`: The URL to the storage location. Can be a local filesystem path or a URL to an object store like S3.
- `RECAP_REGISTRY_STORAGE_URL_ARGS`: Additional arguments to pass to the storage URL.
- `RECAP_REGISTRY_STORAGE_URL_ARGS`: Additional arguments to pass to the storage URL.

The registry is using [fsspec](https://filesystem-spec.readthedocs.io/en/latest/) to store schemas, so fsspec-compatible URLs will work. See the [fsspec implementations](https://filesystem-spec.readthedocs.io/en/latest/api.html#other-known-implementations) and [fsspec documentation](https://filesystem-spec.readthedocs.io/en/latest/usage.html) for more information.

Expand Down
9 changes: 5 additions & 4 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,10 @@ Recap reads and writes schemas from web services, databases, and schema registri

## Components

* Command Line Interface (CLI)
* Stateless HTTP/JSON Gateway
* Python API
* [Command Line Interface (CLI)](/docs/cli/) - Read schemas from other systems using the terminal.
* [Gateway](/docs/gateway/) - Read schemas from other systems using a stateless HTTP/JSON server.
* [Schema Registry](/docs/registry/) - Store and retrieve Recap schemas using an HTTP/JSON server.
* [Python API](/docs/python/) - Use Recap in your Python applications.

## Supported Formats

Expand All @@ -34,4 +35,4 @@ Recap reads and writes schemas from web services, databases, and schema registri

## Getting Started

See the [Quickstart](/docs/quickstart/) guide to get started with Recap.
See the [Quickstart](/docs/quickstart/) guide to get started with Recap.

0 comments on commit dab37d8

Please sign in to comment.