Skip to content
This repository has been archived by the owner on Oct 25, 2024. It is now read-only.

Commit

Permalink
docs: de-emphasize docker in docs (#610)
Browse files Browse the repository at this point in the history
* docs: de-emphasize docker in docs

* update readme snippet

---------

Co-authored-by: Rashad Alston <[email protected]>
  • Loading branch information
ra0x3 and Rashad Alston authored Feb 22, 2023
1 parent 8bf3ab2 commit 9536e52
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 10 deletions.
16 changes: 8 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ The Fuel indexer is a standalone service that can be used to index various compo
- [**For Users**](#for-users)
- [Dependencies](#dependencies)
- [`fuelup`](#fuelup)
- [`docker`](#docker)
- [`wasm`](#wasm)
- [Quickstart](#quickstart)
- [`forc index` Plugin](#forc-index-plugin)
Expand Down Expand Up @@ -56,16 +55,10 @@ Users of the Fuel indexer project include dApp developers looking to write flexi
- We use fuelup in order to get the binaries produced by services in the Fuel ecosystem. Fuelup will install binaries related to the Fuel node, the Fuel indexer, the Fuel orchestrator (forc), and other components.
- fuelup can be downloaded [here](https://github.com/FuelLabs/fuelup).

### `docker`

> IMPORTANT: Docker is not required to run the Fuel indexer.
- We use Docker to produce reproducible environments for users that may be concerned with installing components with large sets of dependencies (e.g. PostgreSQL).
- Docker can be downloaded [here](https://docs.docker.com/engine/install/).

### `wasm`

Two additonal cargo components will be required to build your indexers: `wasm-snip` and the `wasm32-unknown-unknown` target.

- To install `wasm-snip`:

```bash
Expand Down Expand Up @@ -512,6 +505,13 @@ Contributors of the Fuel indexer project are devs looking to help backends for

## Dev Dependencies

### `docker`

> IMPORTANT: Docker is not required to run the Fuel indexer.

- We use Docker to produce reproducible environments for users that may be concerned with installing components with large sets of dependencies (e.g. PostgreSQL).
- Docker can be downloaded [here](https://docs.docker.com/engine/install/).

### Database

At this time, the Fuel indexer requires the use of a database. We currently support a single database option: PostgreSQL. PostgreSQL is a database solution with a complex feature set and requires a database server.
Expand Down
1 change: 0 additions & 1 deletion docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
- [`fuelup`](./getting-started/dependencies/fuelup.md)
- [Database](./getting-started/dependencies/database.md)
- [WASM](./getting-started/dependencies/wasm.md)
- [Docker](./getting-started/dependencies/docker.md)
- [Quickstart](./quickstart/index.md)
- [Starting the Fuel Indexer](./getting-started/starting-the-fuel-indexer.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/src/quickstart/index.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!-- markdownlint-disable MD041 -->
{{#include ../../README.md:80:413}}
{{#include ../../README.md:74:407}}

0 comments on commit 9536e52

Please sign in to comment.