docs: update docs.md and create subdirs

This commit is contained in:
Xiang Li 2016-04-22 16:55:00 -07:00
parent 45bf7fb960
commit bfd6465ea3
9 changed files with 15 additions and 11 deletions

View File

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

View File

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

View File

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