Skip to content

Commit 12bd670

Browse files
committed
fix links in docs
1 parent ab3893a commit 12bd670

File tree

4 files changed

+17
-17
lines changed

4 files changed

+17
-17
lines changed

docs/pages/config/chains.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ chains:
1515
```
1616
1717
## `name`
18-
Type of chain is a short hand to use the default key values for a chain found [here](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/values.yaml#L54...#L244)
18+
Type of chain is a short hand to use the default key values for a chain found [here](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/values.yaml#L54...#L244)
1919
```yaml
2020
chains:
2121
- id: osmosis-1
@@ -72,7 +72,7 @@ chains:
7272
> * Packages `curl,make,bash,jq,sed`
7373
> * Chain binaries installed in $PATH
7474

75-
We create docker images with this [Dockerfile](https://github.com/cosmology-tech/starship/blob/main/docker/chains/Dockerfile), using Heighliner base
75+
We create docker images with this [Dockerfile](https://github.com/cosmology-tech/starship/blob/main/starship/docker/chains/Dockerfile), using Heighliner base
7676
images. All supported docker images can be found [here](https://github.com/orgs/cosmology-tech/packages?repo_name=starship)
7777

7878
## `numValidators`
@@ -88,7 +88,7 @@ chains:
8888
> Note: The first node spun up is a `genesis` node, which spins up before all other validators. Once the genesis node starts
8989
> then all other validator nodes are spun up simultaneously
9090

91-
If number of validators is more than the mnemonics available in the [`keys.json`](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/configs/keys.json#L9) file
91+
If number of validators is more than the mnemonics available in the [`keys.json`](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/configs/keys.json#L9) file
9292
which is 5, then other validators are created with random mnemonic on initialization.
9393

9494
## `ports`
@@ -107,7 +107,7 @@ chains:
107107
```
108108

109109
Available endpoints for extra services:
110-
* `exposer`: https://github.com/cosmology-tech/starship/blob/main/proto/exposer/service.proto#L15
110+
* `exposer`: https://github.com/cosmology-tech/starship/blob/main/starship/proto/exposer/service.proto#L15
111111
* `faucet`: https://github.com/cosmos/cosmjs/blob/main/packages/faucet/README.md#using-the-faucet
112112

113113
> Note: Make sure the ports are not overlapping in the config file
@@ -146,9 +146,9 @@ For more details on the resource directive have a look at [kubernetes resources]
146146
## `faucet` (optional)
147147
Every genesis node runs a faucet. We support 2 types of faucet:
148148
* [cosmjs faucet](https://github.com/cosmos/cosmjs/tree/main/packages/faucet), by default
149-
* [starship faucet](https://github.com/cosmology-tech/starship/tree/main/faucet)
149+
* [starship faucet](https://github.com/cosmology-tech/starship/tree/main/starship/faucet)
150150

151-
Setting for cosmjs-faucet [here](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/values.yaml#L32...#L38) but can be
151+
Setting for cosmjs-faucet [here](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/values.yaml#L32...#L38) but can be
152152
overridden with this directive, specially for compatible cosmjs version with the chain version.
153153

154154
```yaml
@@ -177,7 +177,7 @@ then you can reduce the `concurrency` to a lower number.
177177

178178
## `build` (optional)
179179
With the `build` directive in the chain, one can basically build chain binaries on the fly before starting the chain.
180-
When the directive is `enabled`, then the docker image is set to a [`runner` docker image](https://github.com/cosmology-tech/starship/blob/main/docker/starship/runner/Dockerfile)
180+
When the directive is `enabled`, then the docker image is set to a [`runner` docker image](https://github.com/cosmology-tech/starship/blob/main/starship/docker/starship/runner/Dockerfile)
181181
which is a basic alpine image with starship dependencies.
182182
```yaml
183183
chains:
@@ -231,17 +231,17 @@ chains:
231231

232232
## `scripts` (optional)
233233
Scripts directive will replace the default scripts with the given scripts. In order to use this directive,
234-
one must use [`scripts/install.sh`](https://github.com/cosmology-tech/starship/blob/main/scripts/install.sh) script for running the helm chart.
234+
one must use [`scripts/install.sh`](https://github.com/cosmology-tech/starship/blob/main/starship/scripts/install.sh) script for running the helm chart.
235235

236236
> Since the local scripts are converted into configmaps that are then created in the kubernetes cluster, there is a limit of 1MBi
237237

238238
Types of scripts that are allowed inside the `scripts` dir are:
239-
* `createGenesis`: Script used in the genesis node that will create the `genesis.json` file. Default: [`create-genesis.sh`](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/scripts/default/create-genesis.sh)
240-
* `updateGenesis`: Script used to make custom changes to the genesis file. Default: [`update-genesis.sh`](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/scripts/default/update-genesis.sh)
241-
* `updateConfig`: Script used to make custom changes to the config files. Default: [`update-config.sh`](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/scripts/default/update-config.sh)
242-
* `createValidator`: Script to run the `create-validator` txn on the validator nodes after spinup. Note this script is run as part of the `PostStartHook` of the validator pods. Default: [`create-validator.sh`](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/scripts/default/create-validator.sh)
243-
* `transferTokens`: Script run as part of the Starship glue code. This script is related to the faucet that we run. Default: [`transfer-tokens.sh`](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/scripts/default/transfer-tokens.sh)
244-
* `buildChain`: Script that builds chain binaries, based on the `build` directive. Default: [`build-chain.sh`](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/scripts/default/build-chain.sh)
239+
* `createGenesis`: Script used in the genesis node that will create the `genesis.json` file. Default: [`create-genesis.sh`](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/scripts/default/create-genesis.sh)
240+
* `updateGenesis`: Script used to make custom changes to the genesis file. Default: [`update-genesis.sh`](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/scripts/default/update-genesis.sh)
241+
* `updateConfig`: Script used to make custom changes to the config files. Default: [`update-config.sh`](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/scripts/default/update-config.sh)
242+
* `createValidator`: Script to run the `create-validator` txn on the validator nodes after spinup. Note this script is run as part of the `PostStartHook` of the validator pods. Default: [`create-validator.sh`](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/scripts/default/create-validator.sh)
243+
* `transferTokens`: Script run as part of the Starship glue code. This script is related to the faucet that we run. Default: [`transfer-tokens.sh`](https://github.com/cosmology-tech/starship/blob/main/charts/starship/devnet/scripts/default/transfer-tokens.sh)
244+
* `buildChain`: Script that builds chain binaries, based on the `build` directive. Default: [`build-chain.sh`](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/scripts/default/build-chain.sh)
245245

246246
One can choose the sub-scripts that need to be overwritten, default scripts will be used instead.
247247

docs/pages/config/features.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Here is a list of available endpoints and how to use them:
4242
| `/ibc` | List all ibc info for all chains
4343
| `/ibc/{chain_1}/{chain_2}` | IBC information between the 2 chains specified
4444

45-
Proto definition for the service is [here](https://github.com/cosmology-tech/starship/blob/main/proto/registry/service.proto)
45+
Proto definition for the service is [here](https://github.com/cosmology-tech/starship/blob/main/starship/proto/registry/service.proto)
4646

4747
## Explorer
4848
In order to provide a full fledged emulation environment, we have

docs/pages/config/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Configuration
22

33
In Starship one can define the infra required with a simple config file.
4-
The config file one specifies is merged with the default [`values.yaml`](https://github.com/cosmology-tech/starship/blob/main/charts/devnet/values.yaml)
4+
The config file one specifies is merged with the default [`values.yaml`](https://github.com/cosmology-tech/starship/blob/main/starship/charts/devnet/values.yaml)
55
file before the infra is spun up. All supported directives are present in the default `values.yaml`. We will go over most used ones here.
66

77
Here is a basic example that will spin up:

docs/pages/config/relayers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ relayers:
135135
Available endpoints on
136136
* `rest` endpoints: https://hermes.informal.systems/documentation/rest-api.html?highlight=rest#rest-api
137137
* `exposer` endpoint
138-
* `/create_channel` endpoint: Supports post request. Proto defination: https://github.com/cosmology-tech/starship/blob/main/proto/exposer/service.proto#L47
138+
* `/create_channel` endpoint: Supports post request. Proto defination: https://github.com/cosmology-tech/starship/blob/main/starship/proto/exposer/service.proto#L47
139139

140140
One can use the exposer endpoint on the relayer to create channel from outside.
141141
Note: Still an experimental feature on exposer

0 commit comments

Comments
 (0)