From 9b71573965711361e56fce9d453f0b189c535473 Mon Sep 17 00:00:00 2001 From: Michael Vines Date: Wed, 22 Apr 2020 09:51:01 -0700 Subject: [PATCH] Align ci/publish-docs and ci/test-checks doc builds (#9653) * Align ci/publish-docs and ci/test-checks doc builds * Fix links --- ci/publish-docs.sh | 15 ++++++++------- docs/build.sh | 5 +++-- docs/src/clusters.md | 4 ++-- docs/src/running-validator/validator-start.md | 2 +- 4 files changed, 14 insertions(+), 12 deletions(-) diff --git a/ci/publish-docs.sh b/ci/publish-docs.sh index 0003ee30e5..1b067ddeb0 100755 --- a/ci/publish-docs.sh +++ b/ci/publish-docs.sh @@ -3,21 +3,22 @@ set -e cd "$(dirname "$0")/.." -me=$(basename "$0") +echo --- build docs +( + set -x + . ci/rust-version.sh stable + ci/docker-run.sh "$rust_stable_docker_image" docs/build.sh +) echo --- update gitbook-cage if [[ -n $CI_BRANCH ]]; then ( - set -x - ( - . ci/rust-version.sh stable - ci/docker-run.sh "$rust_stable_docker_image" make -C docs - ) # make a local commit for the svgs and generated/updated markdown + set -x git add -f docs/src if ! git diff-index --quiet HEAD; then git config user.email maintainers@solana.com - git config user.name "$me" + git config user.name "$(basename "$0")" git commit -m "gitbook-cage update $(date -Is)" git push -f git@github.com:solana-labs/solana-gitbook-cage.git HEAD:refs/heads/"$CI_BRANCH" # pop off the local commit diff --git a/docs/build.sh b/docs/build.sh index 27273f1de7..ed928e4685 100755 --- a/docs/build.sh +++ b/docs/build.sh @@ -12,5 +12,6 @@ find src -name '*.md' -a \! -name SUMMARY.md | fi done - -make -j"$(nproc)" test +mdbook --version +mdbook-linkcheck --version +make -j"$(nproc)" diff --git a/docs/src/clusters.md b/docs/src/clusters.md index 532c3f7813..6b71d452a8 100644 --- a/docs/src/clusters.md +++ b/docs/src/clusters.md @@ -49,7 +49,7 @@ $ solana-validator \ * Testnet is where we stress test recent release features on a live cluster, particularly focused on network performance, stability and validator behavior. -* [Tour de SOL](../tour-de-sol/README.md) initiative runs on Testnet, where we +* [Tour de SOL](tour-de-sol/README.md) initiative runs on Testnet, where we encourage malicious behavior and attacks on the network to help us find and squash bugs or network vulnerabilities. * Testnet tokens are **not real** @@ -89,7 +89,7 @@ Currently smart contracts, rewards, and inflation are disabled. * If you have paid money to purchase/be issued tokens, such as through our CoinList auction, these tokens will be transferred on Mainnet Beta. * Note: If you are using a non-command-line wallet such as - [Trust Wallet](../wallet/trust-wallet.md), + [Trust Wallet](wallet/trust-wallet.md), the wallet will always be connecting to Mainnet Beta. * Gossip entrypoint for Mainnet Beta: `mainnet-beta.solana.com:8001` * RPC URL for Mainnet Beta: `https://api.mainnet-beta.solana.com` diff --git a/docs/src/running-validator/validator-start.md b/docs/src/running-validator/validator-start.md index 3dcda373bb..700c3799da 100644 --- a/docs/src/running-validator/validator-start.md +++ b/docs/src/running-validator/validator-start.md @@ -138,7 +138,7 @@ Airdrop yourself some SOL to get started: solana airdrop 10 ``` Note that airdrops are only available on Devnet. Testnet SOL can be obtained by -participating in the [Tour de SOL](../tour-de-sol) program. +participating in the [Tour de SOL](../tour-de-sol/README.md) program. To view your current balance: