Skip to content

Commit a1aa77b

Browse files
committed
docs: apply inline code formatting for indexer-rs component names
1 parent 9d56abd commit a1aa77b

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

website/src/pages/en/indexing/overview.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -133,9 +133,9 @@ At the center of an Indexer's infrastructure is the Graph Node which monitors th
133133

134134
- **IPFS node (version less than 5)** - Subgraph deployment metadata is stored on the IPFS network. The Graph Node primarily accesses the IPFS node during Subgraph deployment to fetch the Subgraph manifest and all linked files. Network Indexers do not need to host their own IPFS node, an IPFS node for the network is hosted at https://ipfs.thegraph.com.
135135

136-
- **Indexer service ([indexer-service-rs](https://github.com/graphprotocol/indexer-rs))** - Handles all required external communications with the network. Shares cost models and indexing statuses, passes query requests from gateways on to a Graph Node, and manages query payments via [GraphTally](/indexing/tap).
136+
- **Indexer service ([`indexer-service-rs`](https://github.com/graphprotocol/indexer-rs))** - Handles all required external communications with the network. Shares cost models and indexing statuses, passes query requests from gateways on to a Graph Node, and manages query payments via [GraphTally](/indexing/tap).
137137

138-
- **TAP agent ([indexer-tap-agent](https://github.com/graphprotocol/indexer-rs))** - Aggregates GraphTally receipts into RAVs (Receipt Aggregate Vouchers) and reconciles redemptions. Exactly one instance should run per indexer.
138+
- **TAP agent ([`indexer-tap-agent`](https://github.com/graphprotocol/indexer-rs))** - Aggregates GraphTally receipts into RAVs (Receipt Aggregate Vouchers) and reconciles redemptions. Exactly one instance should run per indexer.
139139

140140
- **Indexer agent** - Facilitates the Indexers interactions onchain including registering on the network, managing Subgraph deployments to its Graph Node/s, and managing allocations.
141141

@@ -157,7 +157,7 @@ Note: To support agile scaling, it is recommended that query and indexing concer
157157
| 8030 | Subgraph indexing status API | /graphql | --index-node-port | - |
158158
| 8040 | Prometheus metrics | /metrics | --metrics-port | - |
159159

160-
#### Indexer Service (indexer-service-rs)
160+
#### Indexer Service (`indexer-service-rs`)
161161

162162
| Port | Purpose | Routes | CLI Argument | Environment Variable |
163163
| --- | --- | --- | --- | --- |
@@ -369,15 +369,15 @@ To successfully participate in the network requires almost constant monitoring a
369369

370370
- **Indexer agent** - The agent monitors the network and the Indexer's own infrastructure and manages which Subgraph deployments are indexed and allocated towards onchain and how much is allocated towards each.
371371

372-
- **[indexer-service-rs](https://github.com/graphprotocol/indexer-rs)** - The only component that needs to be exposed externally, the service passes on Subgraph queries to the graph node, validates [GraphTally](/indexing/tap) receipts, and shares important decision making information to clients like the gateways.
372+
- **[`indexer-service-rs`](https://github.com/graphprotocol/indexer-rs)** - The only component that needs to be exposed externally, the service passes on Subgraph queries to the graph node, validates [GraphTally](/indexing/tap) receipts, and shares important decision making information to clients like the gateways.
373373

374-
- **[indexer-tap-agent](https://github.com/graphprotocol/indexer-rs)** - Aggregates GraphTally receipts into RAVs and manages receipt-to-payment lifecycle. Run exactly one instance per indexer.
374+
- **[`indexer-tap-agent`](https://github.com/graphprotocol/indexer-rs)** - Aggregates GraphTally receipts into RAVs and manages receipt-to-payment lifecycle. Run exactly one instance per indexer.
375375

376376
- **Indexer CLI** - The command line interface for managing the Indexer agent. It allows Indexers to manage cost models, manual allocations, actions queue, and indexing rules.
377377

378378
#### Getting started
379379

380-
The Indexer agent, indexer-service-rs, and indexer-tap-agent should be co-located with your Graph Node infrastructure. There are many ways to set up virtual execution environments for your Indexer components; here we'll explain how to run them using docker or via kubernetes on the Google Cloud Kubernetes Engine. If these setup examples do not translate well to your infrastructure there will likely be a community guide to reference, come say hi on [Discord](https://discord.gg/graphprotocol)! Remember to [stake in the protocol](/indexing/overview/#stake-in-the-protocol) before starting up your Indexer components!
380+
The Indexer agent, `indexer-service-rs`, and `indexer-tap-agent` should be co-located with your Graph Node infrastructure. There are many ways to set up virtual execution environments for your Indexer components; here we'll explain how to run them using docker or via kubernetes on the Google Cloud Kubernetes Engine. If these setup examples do not translate well to your infrastructure there will likely be a community guide to reference, come say hi on [Discord](https://discord.gg/graphprotocol)! Remember to [stake in the protocol](/indexing/overview/#stake-in-the-protocol) before starting up your Indexer components!
381381

382382
#### Indexer agent (from NPM)
383383

@@ -398,9 +398,9 @@ graph indexer connect http://localhost:18000/
398398
graph indexer ...
399399
```
400400

401-
#### indexer-service-rs and indexer-tap-agent (Docker)
401+
#### `indexer-service-rs` and `indexer-tap-agent` (Docker)
402402

403-
The indexer-service-rs and indexer-tap-agent are Rust applications distributed as Docker images. See the [GraphTally guide](/indexing/tap) for detailed configuration.
403+
The `indexer-service-rs` and `indexer-tap-agent` are Rust applications distributed as Docker images. See the [GraphTally guide](/indexing/tap) for detailed configuration.
404404

405405
```sh
406406
docker pull ghcr.io/graphprotocol/indexer-service-rs:latest
@@ -458,7 +458,7 @@ graph-indexer-agent start \
458458
| pino-pretty
459459
```
460460

461-
#### indexer-service-rs and indexer-tap-agent
461+
#### `indexer-service-rs` and `indexer-tap-agent`
462462

463463
Both `indexer-service-rs` and `indexer-tap-agent` are configured using a shared TOML file. See the [GraphTally guide](/indexing/tap) for detailed configuration and deployment instructions.
464464

0 commit comments

Comments
 (0)