Browse Source

docs: fix broken markdown links (cherry-pick of #7847) (#7848)

For most cases I was able to find a new target. In one case the branch was
deleted, so I removed the link.
pull/7853/head
M. J. Fromberger 3 years ago
committed by GitHub
parent
commit
125817d5cd
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 6 additions and 11 deletions
  1. +1
    -1
      docs/README.md
  2. +1
    -1
      docs/architecture/adr-001-logging.md
  3. +1
    -1
      docs/architecture/adr-044-lite-client-with-weak-subjectivity.md
  4. +0
    -5
      docs/architecture/adr-069-flexible-node-intitalization.md
  5. +1
    -1
      docs/nodes/running-in-production.md
  6. +2
    -2
      docs/tendermint-core/rpc.md

+ 1
- 1
docs/README.md View File

@ -24,7 +24,7 @@ To get started quickly with an example application, see the [quick start guide](
To learn about application development on Tendermint, see the [Application Blockchain Interface](https://github.com/tendermint/spec/tree/master/spec/abci).
For more details on using Tendermint, see the respective documentation for
[Tendermint Core](tendermint-core/), [benchmarking and monitoring](tools/), and [network deployments](networks/).
[Tendermint Core](tendermint-core/), [benchmarking and monitoring](tools/), and [network deployments](nodes/).
To find out about the Tendermint ecosystem you can go [here](https://github.com/tendermint/awesome#ecosystem). If you are a project that is using Tendermint you are welcome to make a PR to add your project to the list.


+ 1
- 1
docs/architecture/adr-001-logging.md View File

@ -213,4 +213,4 @@ type Logger interface {
}
```
See [The Hunt for a Logger Interface](https://go-talks.appspot.com/github.com/ChrisHines/talks/structured-logging/structured-logging.slide). The advantage is greater composability (check out how go-kit defines colored logging or log-leveled logging on top of this interface https://github.com/go-kit/kit/tree/master/log).
See [The Hunt for a Logger Interface](https://web.archive.org/web/20210902161539/https://go-talks.appspot.com/github.com/ChrisHines/talks/structured-logging/structured-logging.slide#1). The advantage is greater composability (check out how go-kit defines colored logging or log-leveled logging on top of this interface https://github.com/go-kit/kit/tree/master/log).

+ 1
- 1
docs/architecture/adr-044-lite-client-with-weak-subjectivity.md View File

@ -84,7 +84,7 @@ The linear verification algorithm requires downloading all headers
between the `TrustHeight` and the `LatestHeight`. The lite client downloads the
full header for the provided `TrustHeight` and then proceeds to download `N+1`
headers and applies the [Tendermint validation
rules](https://docs.tendermint.com/master/spec/blockchain/blockchain.html#validation)
rules](https://docs.tendermint.com/master/spec/light-client/verification/)
to each block.
### Bisecting Verification


+ 0
- 5
docs/architecture/adr-069-flexible-node-intitalization.md View File

@ -252,11 +252,6 @@ N/A
## References
- [this
branch](https://github.com/tendermint/tendermint/tree/tychoish/scratch-node-minimize)
contains experimental work in the implementation of the node package
to unwind some of the hard dependencies between components.
- [the component
graph](https://peter.bourgon.org/go-for-industrial-programming/#the-component-graph)
as a framing for internal service construction.


+ 1
- 1
docs/nodes/running-in-production.md View File

@ -83,7 +83,7 @@ for more information.
Rate-limiting and authentication are another key aspects to help protect
against DOS attacks. Validators are supposed to use external tools like
[NGINX](https://www.nginx.com/blog/rate-limiting-nginx/) or
[traefik](https://docs.traefik.io/middlewares/ratelimit/)
[traefik](https://doc.traefik.io/traefik/middlewares/http/ratelimit/)
to achieve the same things.
## Debugging Tendermint


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

@ -8,13 +8,13 @@ The RPC documentation is hosted here:
- [https://docs.tendermint.com/master/rpc/](https://docs.tendermint.com/master/rpc/)
To update the documentation, edit the relevant `godoc` comments in the [rpc/core directory](https://github.com/tendermint/tendermint/tree/master/rpc/core).
To update the documentation, edit the relevant `godoc` comments in the [rpc directory](https://github.com/tendermint/tendermint/tree/master/rpc).
If you are using Tendermint in-process, you will need to set the version to be displayed in the RPC.
If you are using a makefile with your go project, this can be done by using sed and `ldflags`.
Example:
Example:
```
VERSION := $(shell go list -m github.com/tendermint/tendermint | sed 's:.* ::')


Loading…
Cancel
Save