Skip to content

Commit 62b012a

Browse files
authored
docs(proxyd): update README.md broken links, escape | for helm-docs (#483)
1 parent 67cc307 commit 62b012a

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

charts/proxyd/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
apiVersion: v2
22
name: proxyd
3-
description: Deploy and scale [proxyd](https://github.com/ethereum-optimism/optimism/tree/develop/proxyd) inside Kubernetes with ease
3+
description: Deploy and scale [proxyd](https://github.com/ethereum-optimism/infra/tree/main/proxyd) inside Kubernetes with ease
44

55
# A chart can be either an 'application' or a 'library' chart.
66
#

charts/proxyd/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Proxyd Helm Chart
22

3-
Deploy and scale [proxyd](https://github.com/ethereum-optimism/optimism/tree/develop/proxyd) inside Kubernetes with ease
3+
Deploy and scale [proxyd](https://github.com/ethereum-optimism/infra/tree/main/proxyd) inside Kubernetes with ease
44

55
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) ![Version: 0.6.5](https://img.shields.io/badge/Version-0.6.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v4.12.0](https://img.shields.io/badge/AppVersion-v4.12.0-informational?style=flat-square)
66

77
## Introduction
88

9-
[Proxyd](https://github.com/ethereum-optimism/optimism/tree/develop/proxyd) is an EVM-blockchain JSON-RPC router and load balancer developed in Go by [Optimism](https://www.optimism.io/). It is capable of load balancing, automatic failover, intelligent request routing and very basic caching.
9+
[Proxyd](https://github.com/ethereum-optimism/infra/tree/main/proxyd) is an EVM-blockchain JSON-RPC router and load balancer developed in Go by [Optimism](https://www.optimism.io/). It is capable of load balancing, automatic failover, intelligent request routing and very basic caching.
1010

1111
## Chart Features
1212

@@ -127,7 +127,7 @@ We do not recommend that you upgrade the application by overriding `image.tag`.
127127
| Key | Description | Type | Default |
128128
|-----|-------------|------|---------|
129129
| backendConfigTemplate | TOML configuration for backend | string | `"# How long proxyd should wait for a backend response before timing out.\nresponse_timeout_seconds = 300\n# Maximum response size, in bytes, that proxyd will accept from a backend.\nmax_response_size_bytes = 10737420000 # 10 GiB\n# Maximum number of times proxyd will try a backend before giving up.\nmax_retries = 3\n# Number of seconds to wait before trying an unhealthy backend again.\nout_of_service_seconds = 10\n"` |
130-
| backendGroups.routing_strategy | Set the routing strategy (consensus_aware | multicall | fallback) | string | `"consensus_aware"` |
130+
| backendGroups.routing_strategy | Set the routing strategy (consensus_aware \| multicall \| fallback) | string | `"consensus_aware"` |
131131
| backends.example-backend | Example backend configuration, keep disabled | object | `{"enabled":false,"extraConfig":{},"groups":["main"],"rpcUrl":"http://your-node:8545","wsUrl":"ws://your-node:8545"}` |
132132
| backends.example-backend.enabled | Enable the backend | bool | `false` |
133133
| backends.example-backend.extraConfig | Define additional configuration keys for the backend (see [proxyd config](https://github.com/ethereum-optimism/optimism/blob/5d309e6a6d5e1ef6a88c1ce827b7e6d47f033bbb/proxyd/example.config.toml#L47)) | object | `{}` |

charts/proxyd/README.md.gotmpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Introduction
88

9-
[Proxyd](https://github.com/ethereum-optimism/optimism/tree/develop/proxyd) is an EVM-blockchain JSON-RPC router and load balancer developed in Go by [Optimism](https://www.optimism.io/). It is capable of load balancing, automatic failover, intelligent request routing and very basic caching.
9+
[Proxyd](https://github.com/ethereum-optimism/infra/tree/main/proxyd) is an EVM-blockchain JSON-RPC router and load balancer developed in Go by [Optimism](https://www.optimism.io/). It is capable of load balancing, automatic failover, intelligent request routing and very basic caching.
1010

1111
## Chart Features
1212

charts/proxyd/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ backends:
123123

124124
# -- Options for backend groups
125125
backendGroups:
126-
# -- Set the routing strategy (consensus_aware | multicall | fallback)
126+
# -- Set the routing strategy (consensus_aware \| multicall \| fallback)
127127
routing_strategy: consensus_aware
128128

129129
# -- Mapping JSON-RPC method name to a particular group of backends (method_name -> group_name)

0 commit comments

Comments
 (0)