From 6208ad251dded0e6aaf01f4313140b1254891057 Mon Sep 17 00:00:00 2001 From: John Ky Date: Tue, 14 Feb 2023 22:11:41 +1100 Subject: [PATCH] Markdown link linter config --- .../understanding-config-files.md | 2 +- doc/reference/byron-genesis.md | 4 ++-- doc/reference/native-tokens/01-multi-assets.md | 2 +- doc/reference/tx-metadata.md | 2 +- .../8_register_stakepool.md | 2 +- mlc_config.json | 18 ++++++++++++++++++ scripts/benchmarking/README.md | 4 +--- 7 files changed, 25 insertions(+), 9 deletions(-) create mode 100644 mlc_config.json diff --git a/doc/getting-started/understanding-config-files.md b/doc/getting-started/understanding-config-files.md index add6d8b5680..fa027ae17c1 100644 --- a/doc/getting-started/understanding-config-files.md +++ b/doc/getting-started/understanding-config-files.md @@ -178,7 +178,7 @@ The `genesis.json` file looks like the one below. "securityParam": 2160 } ``` -Here is a brief description of each parameter. You can learn more in the [spec](https://github.com/input-output-hk/cardano-ledger-specs/tree/master/shelley/chain-and-ledger/executable-spec). +Here is a brief description of each parameter. You can learn more in the [spec](https://github.com/input-output-hk/cardano-ledger/tree/master/eras/shelley/impl). | PARAMETER | MEANING | diff --git a/doc/reference/byron-genesis.md b/doc/reference/byron-genesis.md index 010921b4231..2679dcfa50d 100644 --- a/doc/reference/byron-genesis.md +++ b/doc/reference/byron-genesis.md @@ -1,6 +1,6 @@ # Byron genesis data format -Please see [the byron ledger spec](https://hydra.iohk.io/job/Cardano/cardano-ledger-specs/byronLedgerSpec/latest/download-by-type/doc-pdf/ledger-spec) which will describe the changes and deviations of these values in more detail while moving from the Byron era to the OBFT era. +Please see [the byron ledger spec](https://github.com/input-output-hk/cardano-ledger/releases/latest/download/byron-ledger.pdf) which will describe the changes and deviations of these values in more detail while moving from the Byron era to the OBFT era. Let's start with an example: @@ -101,7 +101,7 @@ slot duration, in milliseconds. #### softforkRule Values defining softfork resolution rule. When the stake belonging to block issuers, issuing a given block version, is greater than the current softfork resolution threshold, this block version is adopted. The current softfork resolution threshold is determined as follows: If a proposal is confirmed at the `c`-th epoch, softfork resolution threshold at a later `t`-th epoch will be `max minThd (spInitThd - (t - c) * spThdDecrement)`. -The proportion of ADA that these threshold values (`initThd`,`minThd`,`thdDecrement`) represent is calculated by dividing by 1015. This is an artifact of the old implementation as it would make more sense if the proportion was calculated by the total amount of circulating ADA which is 45 x 1015. Note that in the specification we only make use of the `minThd`. See [here](https://hydra.iohk.io/build/1084792/download/1/ledger-spec.pdf) in section 6.5.4 Adoption threshold. +The proportion of ADA that these threshold values (`initThd`,`minThd`,`thdDecrement`) represent is calculated by dividing by 1015. This is an artifact of the old implementation as it would make more sense if the proportion was calculated by the total amount of circulating ADA which is 45 x 1015. Note that in the specification we only make use of the `minThd`. See [here](https://github.com/input-output-hk/cardano-ledger/releases/latest/download/byron-ledger.pdf) in section 6.5.4 Adoption threshold. - `initThd` - Initial threshold (right after proposal is confirmed). - `minThd` - minimal threshold (i.e. threshold can't become less than this one). diff --git a/doc/reference/native-tokens/01-multi-assets.md b/doc/reference/native-tokens/01-multi-assets.md index 2a01bf23be7..c4f276570db 100644 --- a/doc/reference/native-tokens/01-multi-assets.md +++ b/doc/reference/native-tokens/01-multi-assets.md @@ -1,6 +1,6 @@ # Multi-asset support -From the Mary ledger upgrade and onwards, Cardano supports [multi-assets](https://hydra.iohk.io/job/Cardano/cardano-ledger-specs/specs.shelley-ma/latest/download-by-type/doc-pdf/shelley-ma), also referred to as a *native tokens* feature. This feature extends the ledger’s accounting infrastructure (originally designed for processing ada-only transactions) to accommodate transactions using a range of assets. These assets include ada and a variety of user-defined token types, the mixture of which can be transacted in a single tx output. +From the Mary ledger upgrade and onwards, Cardano supports [multi-assets](https://github.com/input-output-hk/cardano-ledger/releases/download/cardano-ledger-spec-2023-01-18/mary-ledger.pdf), also referred to as a *native tokens* feature. This feature extends the ledger’s accounting infrastructure (originally designed for processing ada-only transactions) to accommodate transactions using a range of assets. These assets include ada and a variety of user-defined token types, the mixture of which can be transacted in a single tx output. ## What is a multi-asset? diff --git a/doc/reference/tx-metadata.md b/doc/reference/tx-metadata.md index 29fc9a34f40..2ed198daff4 100644 --- a/doc/reference/tx-metadata.md +++ b/doc/reference/tx-metadata.md @@ -163,5 +163,5 @@ Detailed Schema: Here are some materials for further reading: -+ Tx metadata motivation and use: [Design Specification for Delegation and Incentives in Cardano](https://hydra.iohk.io/build/3744897/download/1/delegation_design_spec.pdf), p 53. ++ Tx metadata motivation and use: [Design Specification for Delegation and Incentives in Cardano](https://github.com/input-output-hk/cardano-ledger/releases/latest/download/shelley-delegation.pdf), p 53. + [Tx metadata in wallet-CLI](https://github.com/input-output-hk/cardano-wallet/wiki/TxMetadata). diff --git a/doc/stake-pool-operations/8_register_stakepool.md b/doc/stake-pool-operations/8_register_stakepool.md index 457874178ae..01559f2dbcb 100644 --- a/doc/stake-pool-operations/8_register_stakepool.md +++ b/doc/stake-pool-operations/8_register_stakepool.md @@ -69,7 +69,7 @@ After certificate submission, relay nodes will be added to the topology file ena **Related topics:** -- [Establishing connectivity between nodes](https://docs.cardano.org/en/latest/getting-started/stake-pool-operators/establishing-connectivity-between-the-nodes.html) +- [Establishing connectivity between nodes](https://docs.cardano.org/development-guidelines/operating-a-stake-pool/node-connectivity) ### Generate Stake pool registration certificate diff --git a/mlc_config.json b/mlc_config.json new file mode 100644 index 00000000000..c250e81b550 --- /dev/null +++ b/mlc_config.json @@ -0,0 +1,18 @@ +{ + "ignorePatterns": [ + { + "pattern": "^(http|https)://127.0.0.1" + }, + { + "pattern": "https://iohk.myjetbrains.com" + }, + { + "pattern": "https://iohk.zendesk.com" + } + ], + "retryOn429": true, + "aliveStatusCodes": [ + 200, + 206 + ] +} diff --git a/scripts/benchmarking/README.md b/scripts/benchmarking/README.md index cc4644f52ba..55441ea9936 100644 --- a/scripts/benchmarking/README.md +++ b/scripts/benchmarking/README.md @@ -18,7 +18,7 @@ if the `dist-newstyle` directory is absent. Before you can use `--nix`, you'll need to set up Nix -- please see - the `Building under Nix` section [here](https://github.com/input-output-hk/cardano-node/blob/master/doc/building-running.md#building-under-nix) + the `Building cardano-node with Nix` section [here](https://github.com/input-output-hk/cardano-node/blob/master/doc/getting-started/building-the-node-using-nix.md#building-cardano-node-with-nix) 2. using Cabal -- if you already have the development context set up (dependencies, GHC, etc.), then this is the fastest way to iterate. @@ -153,8 +153,6 @@ The `submit-tx.sh` script by default sends the transaction to node with node id NB: This will submit a tx based on the `configuration/defaults/liveview/config-0.yaml` config file. -See cardano-cli's [Transactions](../cardano-node/README.md#transactions) section for instructions on how to generate a tx. - ## Startup testnet with dns You can run: