Browse Source

Docs staging (#4407)

* update theme

* Update version

* Updated Questions section in the footer

* Remove links to Riot chat

* Typo

* Add Discord link

Co-authored-by: Marko <marbar3778@yahoo.com>
pull/4423/head
Denis Fadeev 5 years ago
committed by GitHub
parent
commit
da8813071b
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 35 additions and 58 deletions
  1. +1
    -15
      docs/.vuepress/config.js
  2. +1
    -1
      docs/architecture/adr-051-double-signing-risk-reduction.md
  3. +1
    -1
      docs/architecture/adr-052-tendermint-mode.md
  4. +28
    -34
      docs/package-lock.json
  5. +4
    -7
      docs/package.json

+ 1
- 15
docs/.vuepress/config.js View File

@ -19,12 +19,6 @@ module.exports = {
gutter: { gutter: {
title: "Help & Support", title: "Help & Support",
editLink: true, editLink: true,
chat: {
title: "Riot Chat",
text: "Chat with Tendermint developers on Riot Chat.",
url: "https://riot.im/app/#/room/#tendermint:matrix.org",
bg: "#222"
},
forum: { forum: {
title: "Tendermint Forum", title: "Tendermint Forum",
text: "Join the Tendermint forum to learn more", text: "Join the Tendermint forum to learn more",
@ -38,6 +32,7 @@ module.exports = {
} }
}, },
footer: { footer: {
questionsText: "Chat with Cosmos developers in [Discord](https://discordapp.com/channels/669268347736686612) or reach out on the [SDK Developer Forum](https://forum.cosmos.network/c/tendermint) to learn more.",
logo: "/logo-bw.svg", logo: "/logo-bw.svg",
textLink: { textLink: {
text: "tendermint.com", text: "tendermint.com",
@ -95,10 +90,6 @@ module.exports = {
{ {
title: "Forum", title: "Forum",
url: "https://forum.cosmos.network/c/tendermint" url: "https://forum.cosmos.network/c/tendermint"
},
{
title: "Chat",
url: "https://riot.im/app/#/room/#tendermint:matrix.org"
} }
] ]
}, },
@ -138,11 +129,6 @@ module.exports = {
} }
] ]
}, },
markdown: {
anchor: {
permalinkSymbol: ""
}
},
plugins: [ plugins: [
[ [
"@vuepress/google-analytics", "@vuepress/google-analytics",


+ 1
- 1
docs/architecture/adr-051-double-signing-risk-reduction.md View File

@ -27,7 +27,7 @@ We would like to suggest a double signing risk reduction method.
2. If there exists votes from the validator's consensus key, exit state machine program 2. If there exists votes from the validator's consensus key, exit state machine program
- Configuration - Configuration
- We would like to suggest by introducing `double_sign_check_height` parameter in `config.toml` and cli, how many blocks state machine looks back to check votes - We would like to suggest by introducing `double_sign_check_height` parameter in `config.toml` and cli, how many blocks state machine looks back to check votes
- `double_sign_check_height = {{ .Consensus.DoubleSignCheckHeight }}` in `config.toml`
- <span v-pre>`double_sign_check_height = {{ .Consensus.DoubleSignCheckHeight }}`</span> in `config.toml`
- `tendermint node --double_sign_check_height` in cli - `tendermint node --double_sign_check_height` in cli
- State machine ignore checking procedure when `vote-check-height == 0` - State machine ignore checking procedure when `vote-check-height == 0`


+ 1
- 1
docs/architecture/adr-052-tendermint-mode.md View File

@ -42,7 +42,7 @@ We would like to suggest a simple Tendermint mode abstraction. These modes will
- p2p/pex - p2p/pex
- Configuration, cli command - Configuration, cli command
- We would like to suggest by introducing `mode` parameter in `config.toml` and cli - We would like to suggest by introducing `mode` parameter in `config.toml` and cli
- `mode = "{{ .BaseConfig.Mode }}"` in `config.toml`
- <span v-pre>`mode = "{{ .BaseConfig.Mode }}"`</span> in `config.toml`
- `tendermint node --mode validator` in cli - `tendermint node --mode validator` in cli
- fullnode | validator | seed (default: "fullnode") - fullnode | validator | seed (default: "fullnode")
- RPC modification - RPC modification


+ 28
- 34
docs/package-lock.json View File

@ -1157,12 +1157,6 @@
"lodash.debounce": "^4.0.8" "lodash.debounce": "^4.0.8"
} }
}, },
"@vuepress/plugin-google-analytics": {
"version": "1.2.0",
"resolved": "https://registry.npmjs.org/@vuepress/plugin-google-analytics/-/plugin-google-analytics-1.2.0.tgz",
"integrity": "sha512-0zol5D4Efb5GKel7ADO/s65MLtKSLnOEGkeWzuipkWomSQPzP7TJ3+/RcYBnGdyBFHd1BSpTUHGK0b/IGwM3UA==",
"dev": true
},
"@vuepress/plugin-last-updated": { "@vuepress/plugin-last-updated": {
"version": "1.3.0", "version": "1.3.0",
"resolved": "https://registry.npmjs.org/@vuepress/plugin-last-updated/-/plugin-last-updated-1.3.0.tgz", "resolved": "https://registry.npmjs.org/@vuepress/plugin-last-updated/-/plugin-last-updated-1.3.0.tgz",
@ -2378,9 +2372,9 @@
} }
}, },
"caniuse-lite": { "caniuse-lite": {
"version": "1.0.30001023",
"resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001023.tgz",
"integrity": "sha512-C5TDMiYG11EOhVOA62W1p3UsJ2z4DsHtMBQtjzp3ZsUglcQn62WOUgW0y795c7A5uZ+GCEIvzkMatLIlAsbNTA=="
"version": "1.0.30001027",
"resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001027.tgz",
"integrity": "sha512-7xvKeErvXZFtUItTHgNtLgS9RJpVnwBlWX8jSo/BO8VsF6deszemZSkJJJA1KOKrXuzZH4WALpAJdq5EyfgMLg=="
}, },
"caseless": { "caseless": {
"version": "0.12.0", "version": "0.12.0",
@ -3571,9 +3565,9 @@
"integrity": "sha1-WQxhFWsK4vTwJVcyoViyZrxWsh0=" "integrity": "sha1-WQxhFWsK4vTwJVcyoViyZrxWsh0="
}, },
"electron-to-chromium": { "electron-to-chromium": {
"version": "1.3.344",
"resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.344.tgz",
"integrity": "sha512-tvbx2Wl8WBR+ym3u492D0L6/jH+8NoQXqe46+QhbWH3voVPauGuZYeb1QAXYoOAWuiP2dbSvlBx0kQ1F3hu/Mw=="
"version": "1.3.346",
"resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.346.tgz",
"integrity": "sha512-Yy4jF5hJd57BWmGPt0KjaXc25AmWZeQK75kdr4zIzksWVtiT6DwaNtvTb9dt+LkQKwUpvBfCyyPsXXtbY/5GYw=="
}, },
"elliptic": { "elliptic": {
"version": "6.5.2", "version": "6.5.2",
@ -6086,9 +6080,9 @@
"integrity": "sha512-xLIjLQmtym3QpoY9llBgApknl7pxAcN3WDRc2d3rwpl+/YvDZHPmKscGs+L6E05xf2KrCXPBvosWt7MZukwSpQ==" "integrity": "sha512-xLIjLQmtym3QpoY9llBgApknl7pxAcN3WDRc2d3rwpl+/YvDZHPmKscGs+L6E05xf2KrCXPBvosWt7MZukwSpQ=="
}, },
"markdown-it-attrs": { "markdown-it-attrs": {
"version": "3.0.1",
"resolved": "https://registry.npmjs.org/markdown-it-attrs/-/markdown-it-attrs-3.0.1.tgz",
"integrity": "sha512-fcpdmxdEsctDVJEunPyrirVtU/6zcTMxPxAu4Ofz51PKAa8vRMpmGQXsmXx1HTdIdUPoDonm/RhS/+jTNywj/Q=="
"version": "3.0.2",
"resolved": "https://registry.npmjs.org/markdown-it-attrs/-/markdown-it-attrs-3.0.2.tgz",
"integrity": "sha512-q45vdXU9TSWaHgFkWEFM97YHEoCmOyG9csLLdv3oVC6ARjT77u4wfng9rRtSOMb5UpxzT7zTX5GBbwm15H40dw=="
}, },
"markdown-it-chain": { "markdown-it-chain": {
"version": "1.3.0", "version": "1.3.0",
@ -6559,9 +6553,9 @@
} }
}, },
"node-releases": { "node-releases": {
"version": "1.1.47",
"resolved": "https://registry.npmjs.org/node-releases/-/node-releases-1.1.47.tgz",
"integrity": "sha512-k4xjVPx5FpwBUj0Gw7uvFOTF4Ep8Hok1I6qjwL3pLfwe7Y0REQSAqOwwv9TWBCUtMHxcXfY4PgRLRozcChvTcA==",
"version": "1.1.48",
"resolved": "https://registry.npmjs.org/node-releases/-/node-releases-1.1.48.tgz",
"integrity": "sha512-Hr8BbmUl1ujAST0K0snItzEA5zkJTQup8VNTKNfT6Zw8vTJkIiagUPNfxHmgDOyfFYNfKAul40sD0UEYTvwebw==",
"requires": { "requires": {
"semver": "^6.3.0" "semver": "^6.3.0"
} }
@ -7630,11 +7624,11 @@
} }
}, },
"postcss-safe-parser": { "postcss-safe-parser": {
"version": "4.0.1",
"resolved": "https://registry.npmjs.org/postcss-safe-parser/-/postcss-safe-parser-4.0.1.tgz",
"integrity": "sha512-xZsFA3uX8MO3yAda03QrG3/Eg1LN3EPfjjf07vke/46HERLZyHrTsQ9E1r1w1W//fWEhtYNndo2hQplN2cVpCQ==",
"version": "4.0.2",
"resolved": "https://registry.npmjs.org/postcss-safe-parser/-/postcss-safe-parser-4.0.2.tgz",
"integrity": "sha512-Uw6ekxSWNLCPesSv/cmqf2bY/77z11O7jZGPax3ycZMFU/oi2DMH9i89AdHc1tRwFg/arFoEwX0IS3LCUxJh1g==",
"requires": { "requires": {
"postcss": "^7.0.0"
"postcss": "^7.0.26"
} }
}, },
"postcss-selector-parser": { "postcss-selector-parser": {
@ -8276,9 +8270,9 @@
"integrity": "sha1-79qpjqdFEyTQkrKyFjpqHXqaIUc=" "integrity": "sha1-79qpjqdFEyTQkrKyFjpqHXqaIUc="
}, },
"resolve": { "resolve": {
"version": "1.15.0",
"resolved": "https://registry.npmjs.org/resolve/-/resolve-1.15.0.tgz",
"integrity": "sha512-+hTmAldEGE80U2wJJDC1lebb5jWqvTYAfm3YZ1ckk1gBr0MnCqUKlwK1e+anaFljIl+F5tR5IoZcm4ZDA1zMQw==",
"version": "1.15.1",
"resolved": "https://registry.npmjs.org/resolve/-/resolve-1.15.1.tgz",
"integrity": "sha512-84oo6ZTtoTUpjgNEr5SJyzQhzL72gaRodsSfyxC/AXRvwu0Yse9H8eF9IpGo7b8YetZhlI6v7ZQ6bKBFV/6S7w==",
"requires": { "requires": {
"path-parse": "^1.0.6" "path-parse": "^1.0.6"
} }
@ -10096,9 +10090,9 @@
} }
}, },
"vuepress-theme-cosmos": { "vuepress-theme-cosmos": {
"version": "1.0.148",
"resolved": "https://registry.npmjs.org/vuepress-theme-cosmos/-/vuepress-theme-cosmos-1.0.148.tgz",
"integrity": "sha512-IVzX339e9k25YNC62UZPfkLg50IGCctvlI/TQF6s63eCdh+ayHOPLTFq5zAiYTpP09Dbz4tSC74cQyO3fUyPOQ==",
"version": "1.0.150",
"resolved": "https://registry.npmjs.org/vuepress-theme-cosmos/-/vuepress-theme-cosmos-1.0.150.tgz",
"integrity": "sha512-f4McVndkB+CqJ6mWpOG4UZSR14LJyXqwcgwoDoDUx149g2PKU3qI/AF5AcrM25+4UKMCXFKcJloQCl/aWq+1ig==",
"requires": { "requires": {
"@cosmos-ui/vue": "^0.5.20", "@cosmos-ui/vue": "^0.5.20",
"axios": "^0.19.0", "axios": "^0.19.0",
@ -10181,9 +10175,9 @@
} }
}, },
"webpack-chain": { "webpack-chain": {
"version": "6.3.1",
"resolved": "https://registry.npmjs.org/webpack-chain/-/webpack-chain-6.3.1.tgz",
"integrity": "sha512-PLWPY92p5Vj0hOylUGjRoRY7Kgrns5vmPFAQ9BpSHnBbVbh2akRQVUlbRb2mmGYRSY1FklTULtyVChNmcQjIVg==",
"version": "6.4.0",
"resolved": "https://registry.npmjs.org/webpack-chain/-/webpack-chain-6.4.0.tgz",
"integrity": "sha512-f97PYqxU+9/u0IUqp/ekAHRhBD1IQwhBv3wlJo2nvyELpr2vNnUqO3XQEk+qneg0uWGP54iciotszpjfnEExFA==",
"requires": { "requires": {
"deepmerge": "^1.5.2", "deepmerge": "^1.5.2",
"javascript-stringify": "^2.0.1" "javascript-stringify": "^2.0.1"
@ -10209,9 +10203,9 @@
} }
}, },
"webpack-dev-server": { "webpack-dev-server": {
"version": "3.10.2",
"resolved": "https://registry.npmjs.org/webpack-dev-server/-/webpack-dev-server-3.10.2.tgz",
"integrity": "sha512-pxZKPYb+n77UN8u9YxXT4IaIrGcNtijh/mi8TXbErHmczw0DtPnMTTjHj+eNjkqLOaAZM/qD7V59j/qJsEiaZA==",
"version": "3.10.3",
"resolved": "https://registry.npmjs.org/webpack-dev-server/-/webpack-dev-server-3.10.3.tgz",
"integrity": "sha512-e4nWev8YzEVNdOMcNzNeCN947sWJNd43E5XvsJzbAL08kGc2frm1tQ32hTJslRS+H65LCb/AaUCYU7fjHCpDeQ==",
"requires": { "requires": {
"ansi-html": "0.0.7", "ansi-html": "0.0.7",
"bonjour": "^3.5.0", "bonjour": "^3.5.0",


+ 4
- 7
docs/package.json View File

@ -4,19 +4,16 @@
"description": "Welcome to the Tendermint Core documentation!", "description": "Welcome to the Tendermint Core documentation!",
"main": "index.js", "main": "index.js",
"dependencies": { "dependencies": {
"vuepress-theme-cosmos": "^1.0.148"
},
"devDependencies": {
"@vuepress/plugin-google-analytics": "^1.2.0"
"vuepress-theme-cosmos": "^1.0.150"
}, },
"scripts": { "scripts": {
"preserve": "./pre.sh", "preserve": "./pre.sh",
"serve": "trap 'exit 0' SIGINT; vuepress dev",
"serve": "trap 'exit 0' SIGINT; vuepress dev --no-cache",
"postserve": "./post.sh", "postserve": "./post.sh",
"prebuild": "./pre.sh", "prebuild": "./pre.sh",
"build": "trap 'exit 0' SIGINT; vuepress build",
"build": "trap 'exit 0' SIGINT; vuepress build --no-cache",
"postbuild": "./post.sh" "postbuild": "./post.sh"
}, },
"author": "", "author": "",
"license": "ISC" "license": "ISC"
}
}

Loading…
Cancel
Save