Skip to content
This repository was archived by the owner on Jan 2, 2023. It is now read-only.

Commit a285701

Browse files
TriplEightdanforbesSteve Degosseriebkchr
authored
CI: markdown link checker (paritytech#7145)
* change (CI): markdown link checker * Fix some invalid doc links (re-run of cargo-unleash gen-readme w/ fixes). * Fix some invalid doc links * Fix some invalid doc links * Fix some links * Fix some links * Apply @bkchr suggestions from code review Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Fix more links * Fix more links * typo * Fix more links * Fix more links * Ignore valid link .. check wrongly sees it as invalid * Fix style issue * Fix style issue * change (CI): update style guide link * change (lib): suggestions Co-authored-by: Dan Forbes <dan@danforbes.dev> Co-authored-by: Steve Degosserie <steve@parity.io> Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
1 parent b61d3b3 commit a285701

30 files changed

Lines changed: 148 additions & 67 deletions

File tree

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Check Links
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- master
7+
push:
8+
branches:
9+
- master
10+
11+
jobs:
12+
markdown-link-check:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v2
16+
- uses: gaurav-nelson/github-action-markdown-link-check@v1
17+
with:
18+
use-quiet-mode: 'yes'
19+
config-file: '.github/workflows/mlc_config.json'

.github/workflows/mlc_config.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"ignorePatterns": [
3+
{
4+
"pattern": "^https://crates.io"
5+
}
6+
]
7+
}

.maintain/chaostest/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- markdown-link-check-disable -->
12
chaostest
23
=========
34

@@ -56,7 +57,7 @@ DESCRIPTION
5657
Extra documentation goes here
5758
```
5859

59-
_See code: [src/commands/spawn/index.js](https://github.com/paritytech/substrate/blob/harry/chaostest-init/.maintain/chaostest/src/commands/spawn/index.js)_
60+
_See code: [src/commands/spawn/index.js](https://github.com/paritytech/substrate/blob/master/.maintain/chaostest/src/commands/spawn/index.js)_
6061

6162
## `chaostest singlenodeheight`
6263

@@ -71,7 +72,7 @@ FLAGS
7172
-t, the wait time out before it halts the polling
7273
```
7374

74-
_See code: [src/commands/singlenodeheight/index.js](https://github.com/paritytech/substrate/blob/harry/chaostest-init/.maintain/chaostest/src/commands/singlenodeheight/index.js)_
75+
_See code: [src/commands/singlenodeheight/index.js](https://github.com/paritytech/substrate/blob/master/.maintain/chaostest/src/commands/singlenodeheight/index.js)_
7576

7677
## `chaostest clean`
7778

@@ -85,5 +86,5 @@ FLAGS
8586
-n , the desired namespace to delete on your k8s cluster
8687
```
8788

88-
_See code: [src/commands/clean/index.js](https://github.com/paritytech/substrate/blob/harry/chaostest-init/.maintain/chaostest/src/commands/clean/index.js)_
89+
_See code: [src/commands/clean/index.js](https://github.com/paritytech/substrate/blob/master/.maintain/chaostest/src/commands/clean/index.js)_
8990
<!-- commandsstop -->

.maintain/gitlab/check_line_width.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ do
2525
echo "| error!"
2626
echo "| Lines must not be longer than ${LINE_WIDTH} characters."
2727
echo "| "
28-
echo "| see more https://wiki.parity.io/Substrate-Style-Guide"
28+
echo "| see more https://github.com/paritytech/substrate/blob/master/docs/STYLE_GUIDE.md"
2929
echo "|"
3030
FAIL="true"
3131
fi
@@ -41,7 +41,7 @@ do
4141
echo "| warning!"
4242
echo "| Lines should be longer than ${GOOD_LINE_WIDTH} characters only in exceptional circumstances!"
4343
echo "| "
44-
echo "| see more https://wiki.parity.io/Substrate-Style-Guide"
44+
echo "| see more https://github.com/paritytech/substrate/blob/master/docs/STYLE_GUIDE.md"
4545
echo "|"
4646
fi
4747
echo "| file: ${file}"

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Substrate &middot; [![GitHub license](https://img.shields.io/badge/license-GPL3%2FApache2-blue)](LICENSE) [![GitLab Status](https://gitlab.parity.io/parity/substrate/badges/master/pipeline.svg)](https://gitlab.parity.io/parity/substrate/pipelines) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](docs/CONTRIBUTING.adoc)
1+
# Substrate &middot; [![GitHub license](https://img.shields.io/badge/license-GPL3%2FApache2-blue)](#LICENSE) [![GitLab Status](https://gitlab.parity.io/parity/substrate/badges/master/pipeline.svg)](https://gitlab.parity.io/parity/substrate/pipelines) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](docs/CONTRIBUTING.adoc)
22

33
<p align="center">
44
<img src="/docs/media/sub.gif">

bin/node-template/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ RUST_LOG=debug RUST_BACKTRACE=1 ./target/release/node-template -lruntime=debug -
5555
### Multi-Node Local Testnet
5656

5757
To see the multi-node consensus algorithm in action, run a local testnet with two validator nodes,
58-
Alice and Bob, that have been [configured](/bin/node-template/node/src/chain_spec.rs) as the initial
58+
Alice and Bob, that have been [configured](./node/src/chain_spec.rs) as the initial
5959
authorities of the `local` testnet chain and endowed with testnet units.
6060

6161
Note: this will require two terminal sessions (one for each node).

client/block-builder/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Substrate block builder
22

33
This crate provides the [`BlockBuilder`] utility and the corresponding runtime api
4-
[`BlockBuilder`](sp_block_builder::BlockBuilder).Error
4+
[`BlockBuilder`](https://docs.rs/sc-block-builder/latest/sc_block_builder/struct.BlockBuilder.html).Error
55

66
The block builder utility is used in the node as an abstraction over the runtime api to
77
initialize a block, to push extrinsics and to finalize a block.

client/block-builder/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
//! Substrate block builder
2020
//!
2121
//! This crate provides the [`BlockBuilder`] utility and the corresponding runtime api
22-
//! [`BlockBuilder`](sp_block_builder::BlockBuilder).Error
22+
//! [`BlockBuilder`](sp_block_builder::BlockBuilder).
2323
//!
2424
//! The block builder utility is used in the node as an abstraction over the runtime api to
2525
//! initialize a block, to push extrinsics and to finalize a block.

client/chain-spec/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This crate contains structs and utilities to declare
44
a runtime-specific configuration file (a.k.a chain spec).
55

66
Basic chain spec type containing all required parameters is
7-
[`ChainSpec`](https://docs.rs/sc-chain-spec/latest/sc_chain_spec/struct.ChainSpec.html). It can be extended with
7+
[`ChainSpec`](https://docs.rs/sc-chain-spec/latest/sc_chain_spec/struct.GenericChainSpec.html). It can be extended with
88
additional options that contain configuration specific to your chain.
99
Usually the extension is going to be an amalgamate of types exposed
1010
by Substrate core modules. To allow the core modules to retrieve

client/chain-spec/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
//! a runtime-specific configuration file (a.k.a chain spec).
2121
//!
2222
//! Basic chain spec type containing all required parameters is
23-
//! [`ChainSpec`](./struct.ChainSpec.html). It can be extended with
23+
//! [`GenericChainSpec`]. It can be extended with
2424
//! additional options that contain configuration specific to your chain.
2525
//! Usually the extension is going to be an amalgamate of types exposed
2626
//! by Substrate core modules. To allow the core modules to retrieve

0 commit comments

Comments
 (0)