Browse Source

Merge pull request #5167 from xiang90/doc_reorg

docs: update docs.md and create subdirs
Xiang Li 9 years ago
parent
commit
e51e146a19

+ 0 - 0
Documentation/api_reference_v3.md → Documentation/dev-guide/api_reference_v3.md


+ 0 - 0
Documentation/interacting_v3.md → Documentation/dev-guide/interacting_v3.md


+ 0 - 0
Documentation/local_cluster.md → Documentation/dev-guide/local_cluster.md


+ 0 - 0
Documentation/dev/logging.md → Documentation/dev-internal/logging.md


+ 0 - 0
Documentation/dev/release.md → Documentation/dev-internal/release.md


+ 12 - 7
Documentation/docs.md

@@ -8,11 +8,11 @@ New to etcd? Start by [downloading and building][download_build] etcd!
 
 ## Developing with etcd
 
-Want to develop applications with etcd? Start by setting up a local cluster!
+Want to develop applications with etcd? Start by [setting up a local cluster][local_cluster]!
 
- - Setting up local clusters
- - Interacting with etcd
- - API references
+ - [Setting up local clusters][local_cluster]
+ - [Interacting with etcd][interacting]
+ - [API references][api_ref]
 
 ## Operating etcd clusters
 
@@ -22,7 +22,7 @@ Want to operate etcd clusters? Start by setting up a cluster on multiple machine
  - Configuration
  - Security
  - Monitoring
- - Maintenance
+ - [Maintenance][maintenance]
  - Disaster recovery
  - Performance
 
@@ -33,10 +33,15 @@ Want to learn more about the concepts and internals behind etcd? Read the follow
  - Why etcd
  - Concepts
  - Internals
- - Glossary
+ - [Glossary][glossary]
 
 ## Upgrading and compatibility
 
 ## Troubleshooting
 
-[download_build]: dl_build.md
+[api_ref]: dev-guide/api_reference_v3.md
+[download_build]: dl_build.md
+[glossary]: learning/glossary.md
+[interacting]: dev-guide/interacting_v3.md
+[local_cluster]: dev-guide/local_cluster.md
+[maintenance]: op_guide/maintenance.md

+ 0 - 0
Documentation/glossary.md → Documentation/learning/glossary.md


+ 0 - 1
Documentation/maintenance.md → Documentation/op_guide/maintenance.md

@@ -113,4 +113,3 @@ $ etcdctl snapshot status backup.db
 +----------+----------+------------+------------+
 
 ```
-

+ 3 - 3
scripts/genproto.sh

@@ -65,7 +65,7 @@ done
 # only run when './scripts/genproto.sh -g'
 #
 if [ "$1" = "-g" ]; then
-	echo "protodoc is auto-generating Protocol Buffer documentation..."
+	echo "protodoc is auto-generating grpc API reference documentation..."
 	go get -v -u github.com/coreos/protodoc
 	SHA_PROTODOC="4cd8db83c5595ac514169fda607d1ccb5eef669b"
 	PROTODOC_PATH="${GOPATH}/src/github.com/coreos/protodoc"
@@ -77,11 +77,11 @@ if [ "$1" = "-g" ]; then
 
 	protodoc --directories="etcdserver/etcdserverpb=service_message,storage/storagepb=service_message,lease/leasepb=service_message,auth/authpb=service_message" \
 		--title="etcd API Reference" \
-		--output="Documentation/api_reference_v3.md" \
+		--output="Documentation/dev-guide/api_reference_v3.md" \
 		--message-only-from-this-file="etcdserver/etcdserverpb/rpc.proto"
 
 	echo "protodoc is finished..."
 else
-	echo "skipping Protocol Buffer document auto-generation..."
+	echo "skipping grpc API reference document auto-generation..."
 fi