From bfd6465ea3ad6f163eb88592f2b171600aefc705 Mon Sep 17 00:00:00 2001
From: Xiang Li <xiangli.cs@gmail.com>
Date: Fri, 22 Apr 2016 16:55:00 -0700
Subject: [PATCH] docs: update docs.md and create subdirs

---
 .../{ => dev-guide}/api_reference_v3.md       |  0
 .../{ => dev-guide}/interacting_v3.md         |  0
 .../{ => dev-guide}/local_cluster.md          |  0
 .../{dev => dev-internal}/logging.md          |  0
 .../{dev => dev-internal}/release.md          |  0
 Documentation/docs.md                         | 19 ++++++++++++-------
 Documentation/{ => learning}/glossary.md      |  0
 Documentation/{ => op_guide}/maintenance.md   |  1 -
 scripts/genproto.sh                           |  6 +++---
 9 files changed, 15 insertions(+), 11 deletions(-)
 rename Documentation/{ => dev-guide}/api_reference_v3.md (100%)
 rename Documentation/{ => dev-guide}/interacting_v3.md (100%)
 rename Documentation/{ => dev-guide}/local_cluster.md (100%)
 rename Documentation/{dev => dev-internal}/logging.md (100%)
 rename Documentation/{dev => dev-internal}/release.md (100%)
 rename Documentation/{ => learning}/glossary.md (100%)
 rename Documentation/{ => op_guide}/maintenance.md (99%)

diff --git a/Documentation/api_reference_v3.md b/Documentation/dev-guide/api_reference_v3.md
similarity index 100%
rename from Documentation/api_reference_v3.md
rename to Documentation/dev-guide/api_reference_v3.md
diff --git a/Documentation/interacting_v3.md b/Documentation/dev-guide/interacting_v3.md
similarity index 100%
rename from Documentation/interacting_v3.md
rename to Documentation/dev-guide/interacting_v3.md
diff --git a/Documentation/local_cluster.md b/Documentation/dev-guide/local_cluster.md
similarity index 100%
rename from Documentation/local_cluster.md
rename to Documentation/dev-guide/local_cluster.md
diff --git a/Documentation/dev/logging.md b/Documentation/dev-internal/logging.md
similarity index 100%
rename from Documentation/dev/logging.md
rename to Documentation/dev-internal/logging.md
diff --git a/Documentation/dev/release.md b/Documentation/dev-internal/release.md
similarity index 100%
rename from Documentation/dev/release.md
rename to Documentation/dev-internal/release.md
diff --git a/Documentation/docs.md b/Documentation/docs.md
index 1d1a0d9c8..2098b601e 100644
--- a/Documentation/docs.md
+++ b/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
\ No newline at end of file
+[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
\ No newline at end of file
diff --git a/Documentation/glossary.md b/Documentation/learning/glossary.md
similarity index 100%
rename from Documentation/glossary.md
rename to Documentation/learning/glossary.md
diff --git a/Documentation/maintenance.md b/Documentation/op_guide/maintenance.md
similarity index 99%
rename from Documentation/maintenance.md
rename to Documentation/op_guide/maintenance.md
index 66c1dfa5a..e416ff07f 100644
--- a/Documentation/maintenance.md
+++ b/Documentation/op_guide/maintenance.md
@@ -113,4 +113,3 @@ $ etcdctl snapshot status backup.db
 +----------+----------+------------+------------+
 
 ```
-
diff --git a/scripts/genproto.sh b/scripts/genproto.sh
index 1a588bf19..5f56d90f4 100755
--- a/scripts/genproto.sh
+++ b/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