From 1cb91853d01b150d89277ecc0ec6923b139b8968 Mon Sep 17 00:00:00 2001 From: Mathieu Baudet <1105398+ma2bd@users.noreply.github.com> Date: Sun, 8 Dec 2024 16:14:51 +0100 Subject: [PATCH] run mdbook test again in CI (#171) * fix markdown * attempt to run mdbook test again in CI * use standard Rust install * pin the version of mdbook --- .github/workflows/documentation.yml | 11 +++++------ src/operators/testnets/joining.md | 6 +++--- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 23b374fb..595a1732 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -24,12 +24,12 @@ jobs: with: submodules: 'true' - - uses: Twey/setup-rust-toolchain@v1 + - uses: actions-rust-lang/setup-rust-toolchain@v1 - name: 'Setup mdbook' - uses: peaceiris/actions-mdbook@v1 + uses: peaceiris/actions-mdbook@v2 with: - mdbook-version: 'latest' + mdbook-version: '0.4.37' - name: 'Install Protoc' uses: arduino/setup-protoc@v3 @@ -47,9 +47,8 @@ jobs: - run: mdbook build -# TODO(#108): https://github.com/linera-io/linera-documentation/issues/108 -# - name: 'Check documentation' -# run: mdbook test -L linera-protocol/target/debug/deps/ + - name: 'Check documentation' + run: mdbook test -L linera-protocol/target/debug/deps/ formatting: runs-on: ubuntu-latest diff --git a/src/operators/testnets/joining.md b/src/operators/testnets/joining.md index e67a6206..1420d16c 100644 --- a/src/operators/testnets/joining.md +++ b/src/operators/testnets/joining.md @@ -26,7 +26,7 @@ Minimum supported version: 1.18.0. Below is an example Nginx configuration which upholds the infrastructure requirements found in `/etc/nginx/sites-available/default`: -``` +```ignore server { listen 80 http2; @@ -69,7 +69,7 @@ Minimum supported version: v2.4.3 Below is an example Caddy configuration which upholds the infrastructure requirements found in `/etc/caddy/Caddyfile`: -``` +```ignore example.com { reverse_proxy localhost:19100 { transport http { @@ -135,7 +135,7 @@ below. To verify the installation, you can use the `query-validator` command. For example: -``` +```bash $ linera wallet init --with-new-chain --faucet https://faucet.{{#include ../../../TESTNET_DOMAIN}}.linera.net $ linera query-validator grpcs:my-domain.com:443