From 037700388b3f1230ad4ddf29efbfb3e7168a287f Mon Sep 17 00:00:00 2001 From: Denali Marsh Date: Mon, 15 Jun 2020 04:11:29 -0700 Subject: [PATCH] Update docs for mainnet (#579) * kava-3 migration guide * update readme for mainnet * fix broken link * build against new cache * remove link, deploy, then reinstate it * add it back in... * revert to original * add ipfs to link-check ignore regex --- Makefile | 2 +- README.md | 10 ++++++++-- docs/.vuepress/config.js | 4 ++++ docs/pre.sh | 4 ++++ docs/readme.md | 12 +++++++++--- 5 files changed, 26 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index 1e820053..22c42400 100644 --- a/Makefile +++ b/Makefile @@ -101,7 +101,7 @@ clean: # This tool checks local markdown links as well. # Set to exclude riot links as they trigger false positives link-check: - @go run github.com/raviqqe/liche -r . --exclude "^http://127.*|^https://riot.im/app*|^http://kava-testnet*|^https://testnet-dex*|^https://kava3.data.kava.io*" + @go run github.com/raviqqe/liche -r . --exclude "^http://127.*|^https://riot.im/app*|^http://kava-testnet*|^https://testnet-dex*|^https://kava3.data.kava.io*|^https://ipfs.io*" lint: diff --git a/README.md b/README.md index fef98e30..756b0b56 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ git checkout v0.8.1 make install ``` -## Mainnet Upgrade +### Upgrade The scheduled mainnet upgrade to `kava-3` took place on June 10th, 2020 at 14:00 UTC. The version of Kava for `kava-3` is [__v0.8.1__](https://github.com/Kava-Labs/kava/releases/tag/v0.8.1). @@ -51,7 +51,13 @@ jq -S -c -M '' genesis.json | shasum -a 256 ## Testnet -For further information on joining the lastest testnet, head over to the [testnet repo](https://github.com/Kava-Labs/kava-testnets). +The recommended version of the software for kava-testnet-6000 is v0.8.0-rc1. For further information on joining the testnet, head over to the [testnet repo](https://github.com/Kava-Labs/kava-testnets). + +## Docs + +Kava protocol and client documentation can be found in the [Kava docs](https://docs.kava.io). + +If you have technical questions or concerns, ask a developer or community member in the [Kava discord](https://discord.com/invite/kQzh3Uv). ## License diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index dbbdbbf9..5d6c6e11 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -27,6 +27,10 @@ module.exports = { { title: "JavaScript SDK", path: "/building/javascript-sdk.html" + }, + { + title: "Migration Guide: kava-3", + path: "/building/kava-3-migration-guide.html" } ] }, diff --git a/docs/pre.sh b/docs/pre.sh index f03365b6..56a35fda 100755 --- a/docs/pre.sh +++ b/docs/pre.sh @@ -1,5 +1,6 @@ #!/usr/bin/env bash +# Clone each module's markdown files mkdir -p Modules for D in ../x/*; do @@ -22,6 +23,9 @@ parent: order: false ---" > "./${clientDir}/readme.md" +# Copy the kava-3-migration guide +cp ../contrib/kava-3/migration.md "./${clientDir}/kava-3-migration-guide.md" + # Kava Tools docs toolsGitRepo="kava-tools" toolsDir="tools" diff --git a/docs/readme.md b/docs/readme.md index 47974276..df53b581 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -6,18 +6,24 @@ Reference implementation of Kava, a blockchain for cross-chain DeFi. Built using ## Mainnet -Note, the current recommended version of the software for mainnet is v0.3.2. The master branch of this repository contains considerable development work since the last mainnet release and is **not** runnable on mainnet. +The current recommended version of the software for mainnet is [v0.8.1](https://github.com/Kava-Labs/kava/releases/tag/v0.8.1). Note, the master branch of this repository contains development work since the last mainnet release and it may **not** be runnable on mainnet. ### Installation ```sh -git checkout v0.3.2 +git checkout v0.8.1 make install ``` +### Upgrade + +The mainnet upgrade to `kava-3` took place on June 10th, 2020 at 14:00 UTC. The version of Kava for `kava-3` is [__v0.8.1__](https://github.com/Kava-Labs/kava/releases/tag/v0.8.1). + +Migration instructions can be found [here](https://docs.kava.io/building/kava-3-migration-guide.html). + ## Testnet -The recommended version of the software for kava-testnet-4000 is v0.4.1. For further information on joining the testnet, head over to the [testnet repo](https://github.com/Kava-Labs/kava-testnets). +The recommended version of the software for kava-testnet-6000 is v0.8.0-rc1. For further information on joining the testnet, head over to the [testnet repo](https://github.com/Kava-Labs/kava-testnets). ## License