From 60d7486de27d121a1a86b32e8107de5f50626562 Mon Sep 17 00:00:00 2001 From: Zach Ramsay Date: Tue, 22 May 2018 14:46:56 -0400 Subject: [PATCH 1/2] docs: fix dead links, closes #1608 --- docs/spec/p2p/node.md | 2 +- docs/spec/p2p/peer.md | 2 +- p2p/README.md | 10 +++++----- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/spec/p2p/node.md b/docs/spec/p2p/node.md index c54cfeb32..5f5b312ce 100644 --- a/docs/spec/p2p/node.md +++ b/docs/spec/p2p/node.md @@ -12,7 +12,7 @@ Seeds should operate full nodes with the PEX reactor in a "crawler" mode that continuously explores to validate the availability of peers. Seeds should only respond with some top percentile of the best peers it knows about. -See [the peer-exchange docs](/docs/specification/new-spec/reactors/pex/pex.md)for details on peer quality. +See [the peer-exchange docs](../reactors/pex/pex.md)for details on peer quality. ## New Full Node diff --git a/docs/spec/p2p/peer.md b/docs/spec/p2p/peer.md index b2808a60b..c9d05d5ac 100644 --- a/docs/spec/p2p/peer.md +++ b/docs/spec/p2p/peer.md @@ -2,7 +2,7 @@ This document explains how Tendermint Peers are identified and how they connect to one another. -For details on peer discovery, see the [peer exchange (PEX) reactor doc](/docs/specification/new-spec/reactors/pex/pex.md). +For details on peer discovery, see the [peer exchange (PEX) reactor doc](../reactors/pex/pex.md). ## Peer Identity diff --git a/p2p/README.md b/p2p/README.md index 9a8ddc6c3..98e9ce2d9 100644 --- a/p2p/README.md +++ b/p2p/README.md @@ -4,8 +4,8 @@ The p2p package provides an abstraction around peer-to-peer communication. Docs: -- [Connection](../docs/specification/new-spec/p2p/connection.md) for details on how connections and multiplexing work -- [Peer](../docs/specification/new-spec/p2p/peer.md) for details on peer ID, handshakes, and peer exchange -- [Node](../docs/specification/new-spec/p2p/node.md) for details about different types of nodes and how they should work -- [Pex](../docs/specification/new-spec/p2p/pex.md) for details on peer discovery and exchange -- [Config](../docs/specification/new-spec/p2p/config.md) for details on some config option \ No newline at end of file +- [Connection](../docs/spec/p2p/connection.md) for details on how connections and multiplexing work +- [Peer](../docs/spec/p2p/peer.md) for details on peer ID, handshakes, and peer exchange +- [Node](../docs/spec/p2p/node.md) for details about different types of nodes and how they should work +- [Pex](../docs/spec/reactors/pex/pex.md) for details on peer discovery and exchange +- [Config](../docs/spec/p2p/config.md) for details on some config option From a0201e78622f9fb1899c97a73142e9087613743d Mon Sep 17 00:00:00 2001 From: Zach Ramsay Date: Tue, 22 May 2018 15:09:47 -0400 Subject: [PATCH 2/2] docker readme: update --- DOCKER/README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/DOCKER/README.md b/DOCKER/README.md index 2fe3db866..fd05d1b0f 100644 --- a/DOCKER/README.md +++ b/DOCKER/README.md @@ -17,7 +17,7 @@ # Quick reference * **Where to get help:** - https://tendermint.com/community + https://cosmos.network/community * **Where to file issues:** https://github.com/tendermint/tendermint/issues @@ -37,25 +37,29 @@ To get started developing applications, see the [application developers guide](h ## Start one instance of the Tendermint core with the `kvstore` app -A very simple example of a built-in app and Tendermint core in one container. +A quick example of a built-in app and Tendermint core in one container. ``` docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint init docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint node --proxy_app=kvstore ``` -## mintnet-kubernetes +# Local cluster -If you want to see many containers talking to each other, consider using [mintnet-kubernetes](https://github.com/tendermint/tools/tree/master/mintnet-kubernetes), which is a tool for running Tendermint-based applications on a Kubernetes cluster. +To run a 4-node network, see the `Makefile` in the root of [the repo](https://github.com/tendermint/tendermint/master/Makefile) and run: -# License +``` +make build-linux +make build-docker-localnode +make localnet-start +``` -View [license information](https://raw.githubusercontent.com/tendermint/tendermint/master/LICENSE) for the software contained in this image. +Note that this will build and use a different image than the ones provided here. -# User Feedback +# License -## Contributing +- Tendermint's license is [Apache 2.0](https://github.com/tendermint/tendermint/master/LICENSE). -You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can. +# Contributing -Before you start to code, we recommend discussing your plans through a [GitHub](https://github.com/tendermint/tendermint/issues) issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing. +Contributions are most welcome! See the [contributing file](https://github.com/tendermint/tendermint/blob/master/CONTRIBUTING.md) for more information.