Browse Source

fix docs links (#2352)

pull/2177/merge
xiaoping 6 years ago
committed by Anton Kaliaev
parent
commit
dea4e96f66
11 changed files with 34 additions and 16 deletions
  1. +4
    -0
      .gitignore
  2. +16
    -2
      docs/DOCS_README.md
  3. +3
    -3
      docs/app-dev/getting-started.md
  4. +1
    -1
      docs/networks/deploy-testnets.md
  5. +1
    -1
      docs/research/transactional-semantics.md
  6. +1
    -1
      docs/spec/blockchain/encoding.md
  7. +1
    -1
      docs/spec/consensus/consensus.md
  8. +1
    -1
      docs/tendermint-core/how-to-read-logs.md
  9. +3
    -3
      docs/tendermint-core/light-client-protocol.md
  10. +1
    -1
      docs/tendermint-core/using-tendermint.md
  11. +2
    -2
      docs/tendermint-core/validators.md

+ 4
- 0
.gitignore View File

@ -14,6 +14,8 @@ test/p2p/data/
test/logs
coverage.txt
docs/_build
docs/.vuepress
docs/dist
*.log
abci-cli
docs/node_modules/
@ -25,6 +27,8 @@ scripts/cutWALUntil/cutWALUntil
.idea/
*.iml
.vscode/
libs/pubsub/query/fuzz_test/output
shunit2


+ 16
- 2
docs/DOCS_README.md View File

@ -4,9 +4,15 @@ The documentation found in this directory is hosted at:
- https://tendermint.com/docs/
and built using [VuePress](https://vuepress.vuejs.org/) from the tendermint website repo:
and built using [VuePress](https://vuepress.vuejs.org/) like below:
- https://github.com/tendermint/tendermint.com
```bash
npm install -g vuepress # global install vuepress tool, only once
npm install
mkdir -p .vuepress && cp config.js .vuepress/
vuepress build
```
Under the hood, Jenkins listens for changes (on develop or master) in ./docs then rebuilds
either the staging or production site depending on which branch the changes were made.
@ -15,3 +21,11 @@ To update the Table of Contents (layout of the documentation sidebar), edit the
`config.js` in this directory, while the `README.md` is the landing page for the
website documentation.
To view the latest documentation on the develop branch, see the staging site:
- https://tendermint-staging.interblock.io/docs/
and the documentation on master branch is found here:
- https://tendermint.com/docs/

+ 3
- 3
docs/app-dev/getting-started.md View File

@ -7,7 +7,7 @@ application you want to run. So, to run a complete blockchain that does
something useful, you must start two programs: one is Tendermint Core,
the other is your application, which can be written in any programming
language. Recall from [the intro to
ABCI](./introduction.md#ABCI-Overview) that Tendermint Core handles all
ABCI](../introduction/introduction.md#ABCI-Overview) that Tendermint Core handles all
the p2p and consensus stuff, and just forwards transactions to the
application when they need to be validated, or when they're ready to be
committed to a block.
@ -64,7 +64,7 @@ tendermint node
If you have used Tendermint, you may want to reset the data for a new
blockchain by running `tendermint unsafe_reset_all`. Then you can run
`tendermint node` to start Tendermint, and connect to the app. For more
details, see [the guide on using Tendermint](./using-tendermint.md).
details, see [the guide on using Tendermint](../tendermint-core/using-tendermint.md).
You should see Tendermint making blocks! We can get the status of our
Tendermint node as follows:
@ -244,7 +244,7 @@ But if we send a `1`, it works again:
```
For more details on the `broadcast_tx` API, see [the guide on using
Tendermint](./using-tendermint.md).
Tendermint](../tendermint-core/using-tendermint.md).
## CounterJS - Example in Another Language


+ 1
- 1
docs/networks/deploy-testnets.md View File

@ -36,7 +36,7 @@ tendermint node --proxy_app=kvstore --p2p.persistent_peers=96663a3dd0d7b9d17d4c8
After a few seconds, all the nodes should connect to each other and
start making blocks! For more information, see the Tendermint Networks
section of [the guide to using Tendermint](./using-tendermint.md).
section of [the guide to using Tendermint](../tendermint-core/using-tendermint.md).
But wait! Steps 3, 4 and 5 are quite manual. Instead, use the `tendermint testnet` command. By default, running `tendermint testnet` will create all the
required files, but it won't populate the list of persistent peers. It will do


+ 1
- 1
docs/research/transactional-semantics.md View File

@ -1,6 +1,6 @@
# Transactional Semantics
In [Using Tendermint](./using-tendermint.md#broadcast-api) we
In [Using Tendermint](../tendermint-core/using-tendermint.md#broadcast-api) we
discussed different API endpoints for sending transactions and
differences between them.


+ 1
- 1
docs/spec/blockchain/encoding.md View File

@ -269,7 +269,7 @@ similarly derived.
### IAVL+ Tree
Because Tendermint only uses a Simple Merkle Tree, application developers are expect to use their own Merkle tree in their applications. For example, the IAVL+ Tree - an immutable self-balancing binary tree for persisting application state is used by the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/core/multistore.md)
Because Tendermint only uses a Simple Merkle Tree, application developers are expect to use their own Merkle tree in their applications. For example, the IAVL+ Tree - an immutable self-balancing binary tree for persisting application state is used by the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk/blob/develop/docs/sdk/core/multistore.md)
## JSON


+ 1
- 1
docs/spec/consensus/consensus.md View File

@ -282,7 +282,7 @@ may make JSet verification/gossip logic easier to implement.
### Censorship Attacks
Due to the definition of a block
[commit](../../tendermint-core/validator.md#commiting-a-block), any 1/3+ coalition of
[commit](../../tendermint-core/validators.md#commit-a-block), any 1/3+ coalition of
validators can halt the blockchain by not broadcasting their votes. Such
a coalition can also censor particular transactions by rejecting blocks
that include these transactions, though this would result in a


+ 1
- 1
docs/tendermint-core/how-to-read-logs.md View File

@ -127,7 +127,7 @@ little overview what they do.
found
[here](https://github.com/tendermint/tendermint/blob/master/types/events.go).
You can subscribe to them by calling `subscribe` RPC method. Refer
to [RPC docs](./specification/rpc.md) for additional information.
to [RPC docs](./rpc.md) for additional information.
- `mempool` Mempool module handles all incoming transactions, whenever
they are coming from peers or the application.
- `p2p` Provides an abstraction around peer-to-peer communication. For


+ 3
- 3
docs/tendermint-core/light-client-protocol.md View File

@ -10,11 +10,11 @@ package](https://godoc.org/github.com/tendermint/tendermint/lite).
## Overview
The objective of the light client protocol is to get a
[commit](./validators.md#committing-a-block) for a recent [block
hash](../spec/consensus/consensus.md.md#block-hash) where the commit includes a
commit for a recent block
hash where the commit includes a
majority of signatures from the last known validator set. From there,
all the application state is verifiable with [merkle
proofs](./merkle.md#iavl-tree).
proofs](../spec/blockchain/encoding.md#iavl-tree).
## Properties


+ 1
- 1
docs/tendermint-core/using-tendermint.md View File

@ -225,7 +225,7 @@ new blockchain will not make any blocks.
## Configuration
Tendermint uses a `config.toml` for configuration. For details, see [the
config specification](./tendermint-core/configuration.md).
config specification](./configuration.md).
Notable options include the socket address of the application
(`proxy_app`), the listening address of the Tendermint peer


+ 2
- 2
docs/tendermint-core/validators.md View File

@ -22,7 +22,7 @@ Validators have a cryptographic key-pair and an associated amount of
There are two ways to become validator.
1. They can be pre-established in the [genesis state](../../tendermint-core/using-tendermint.md#genesis)
1. They can be pre-established in the [genesis state](./using-tendermint.md#genesis)
2. The ABCI app responds to the EndBlock message with changes to the
existing validator set.
@ -36,4 +36,4 @@ The +2/3 set of precommit votes is called a
[_commit_](../spec/blockchain/blockchain.md#commit). While any +2/3 set of
precommits for the same block at the same height&round can serve as
validation, the canonical commit is included in the next block (see
[LastCommit](../spec/blockchain/blockchain.md#last-commit)).
[LastCommit](../spec/blockchain/blockchain.md#lastcommit)).

Loading…
Cancel
Save