ソースを参照

Documentation: removed an extra step for testing etcd

removed an extra step for testing etce build that might confuse the user of the flow. minimal editing to the doc
Radhika Puthiyetath 8 年 前
コミット
52afc03d68
1 ファイル変更13 行追加7 行削除
  1. 13 7
      Documentation/dl_build.md

+ 13 - 7
Documentation/dl_build.md

@@ -2,7 +2,7 @@
 
 ## System requirements
 
-The etcd performance benchmarks run etcd on 8 vCPU, 16GB RAM, 50GB SSD GCE instances, but any relatively modern machine with low latency storage and a few gigabytes of memory should suffice for most use cases. Applications with large v2 data stores will require more memory than a large v3 data store since data is kept in anonymous memory instead of memory mapped from a file. than For running etcd on a cloud provider, we suggest at least a medium instance on AWS or a standard-1 instance on GCE.
+The etcd performance benchmarks run etcd on 8 vCPU, 16GB RAM, 50GB SSD GCE instances, but any relatively modern machine with low latency storage and a few gigabytes of memory should suffice for most use cases. Applications with large v2 data stores will require more memory than a large v3 data store since data is kept in anonymous memory instead of memory mapped from a file. For running etcd on a cloud provider, see the [Example hardware configuration][example-hardware-configurations] documentation.
 
 ## Download the pre-built binary
 
@@ -18,7 +18,6 @@ To build `etcd` from the `master` branch without a `GOPATH` using the official `
 $ git clone https://github.com/coreos/etcd.git
 $ cd etcd
 $ ./build
-$ ./bin/etcd
 ```
 
 To build a vendored `etcd` from the `master` branch via `go get`:
@@ -28,7 +27,6 @@ To build a vendored `etcd` from the `master` branch via `go get`:
 $ echo $GOPATH
 /Users/example/go
 $ go get github.com/coreos/etcd/cmd/etcd
-$ $GOPATH/bin/etcd
 ```
 
 To build `etcd` from the `master` branch without vendoring (may not build due to upstream conflicts):
@@ -38,20 +36,28 @@ To build `etcd` from the `master` branch without vendoring (may not build due to
 $ echo $GOPATH
 /Users/example/go
 $ go get github.com/coreos/etcd
-$ $GOPATH/bin/etcd
 ```
 
 ## Test the installation
 
 Check the etcd binary is built correctly by starting etcd and setting a key.
 
-Start etcd:
+### Starting etcd
+
+If etcd is built without using GOPATH, run the following:
 
 ```
 $ ./bin/etcd
 ```
+If etcd is built using GOPATH, run the following:
+
+```
+$ $GOPATH/bin/etcd
+```
 
-Set a key:
+### Setting a key
+
+Run the following:
 
 ```
 $ ETCDCTL_API=3 ./bin/etcdctl put foo bar
@@ -64,4 +70,4 @@ If OK is printed, then etcd is working!
 [go]: https://golang.org/doc/install
 [build-script]: ../build
 [cmd-directory]: ../cmd
-
+[example-hardware-configurations]: op-guide/hardware.md#example-hardware-configurations