Merge "FAB-8666 refactor fabric docs TOC" into release-1.1

hyperledger · Mar 10, 2018 · 07de8ea · 07de8ea
2 parents 4bf4f24 + 15ec7d1
commit 07de8ea
Show file tree

Hide file tree

Showing 8 changed files with 128 additions and 123 deletions.
diff --git a/docs/source/CONTRIBUTING.rst b/docs/source/CONTRIBUTING.rst
@@ -8,6 +8,21 @@ First things first, please review the Hyperledger `Code of
 Conduct <https://wiki.hyperledger.org/community/hyperledger-project-code-of-conduct>`__
 before participating. It is important that we keep things civil.
 
+.. toctree::
+   :maxdepth: 1
+
+   MAINTAINERS
+   jira_navigation
+   dev-setup/devenv
+   dev-setup/build
+   Gerrit/lf-account
+   Gerrit/gerrit
+   Gerrit/changes
+   Gerrit/reviewing
+   Gerrit/best-practices
+   testing
+   Style-guides/go-style
+
 Install prerequisites
 ---------------------
 

diff --git a/docs/source/architecture.rst b/docs/source/architecture.rst
@@ -0,0 +1,16 @@
+Architecture Reference
+======================
+
+.. toctree::
+   :maxdepth: 1
+
+   arch-deep-dive
+   txflow
+   Hyperledger Fabric CA's User Guide <http://hyperledger-fabric-ca.readthedocs.io/en/latest>
+   fabric-sdks
+   channels
+   capability_requirements
+   couchdb_as_state_database
+   peer_event_services
+   readwrite
+   gossip
diff --git a/docs/source/command_ref.rst b/docs/source/command_ref.rst
@@ -0,0 +1,16 @@
+Commands Reference
+==================
+
+.. toctree::
+   :maxdepth: 1
+
+   commands/peercommand.md
+   commands/peerchaincode.md
+   commands/peerchannel.md
+   commands/peerversion.md
+   commands/peerlogging.md
+   commands/peernode.md
+   commands/configtxgen.md
+   commands/configtxlator.md
+   commands/cryptogen-commands
+   commands/fabric-ca-commands
diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -1,6 +1,12 @@
 Getting Started
 ===============
 
+.. toctree::
+   :maxdepth: 1
+
+   prereqs
+   samples
+
 Install Prerequisites
 ^^^^^^^^^^^^^^^^^^^^^
 
@@ -50,27 +56,5 @@ that you may choose to use to generate the certificates and key material
 to configure and manage identity in your blockchain network. However, any CA
 that can generate ECDSA certificates may be used.
 
-Tutorials
-^^^^^^^^^
-
-We offer four initial tutorials to get you started with Hyperledger Fabric.
-The first is oriented to the Hyperledger Fabric **application developer**,
-:doc:`write_first_app`. It takes you through the process of writing your first
-blockchain application for Hyperledger Fabric using the Hyperledger Fabric
-`Node SDK <https://github.com/hyperledger/fabric-sdk-node>`__.
-
-The second tutorial is oriented towards the Hyperledger Fabric network
-operators, :doc:`build_network`. This one walks you through the process of
-establishing a blockchain network using Hyperledger Fabric and provides
-a basic sample application to test it out.
-
-Finally, we offer two chaincode tutorials. One oriented to developers,
-:doc:`chaincode4ade`, and the other oriented to operators,
-:doc:`chaincode4noah`.
-
-.. note:: If you have questions not addressed by this documentation, or run into
-          issues with any of the tutorials, please visit the :doc:`questions`
-          page for some tips on where to find additional help.
-
 .. Licensed under Creative Commons Attribution 4.0 International License
    https://creativecommons.org/licenses/by/4.0/
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -30,111 +30,19 @@ Business:
    <br/><br/>
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Getting Started
-
-   prereqs
+   :maxdepth: 1
+   :caption: Table of Contents
+   
+   index
    getting_started
-   samples
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Key Concepts
-
-   blockchain
-   functionalities
-   fabric_model
-   identity/identity.md
-   membership/membership.md
-   ledger
-   usecases
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Tutorials
-
-   build_network
-   write_first_app
-   channel_update_tutorial
-   upgrading_your_network_tutorial
-   chaincode
-   chaincode4ade
-   chaincode4noah
-   systemchaincode
-   videos
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Operations Guide
-
-   upgrade_to_one_point_one
-   config_update
-   msp
-   configtx
-   endorsement-policies
-   error-handling
-   logging-control
-   enable_tls
-   kafka
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Command Reference
-
-   commands/peercommand.md
-   commands/peerchaincode.md
-   commands/peerchannel.md
-   commands/peerversion.md
-   commands/peerlogging.md
-   commands/peernode.md
-   commands/configtxgen.md
-   commands/configtxlator.md
-   commands/cryptogen-commands
-   commands/fabric-ca-commands
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Architecture
-
-   arch-deep-dive
-   txflow
-   Hyperledger Fabric CA's User Guide <http://hyperledger-fabric-ca.readthedocs.io/en/latest>
-   fabric-sdks
-   channels
-   capability_requirements
-   couchdb_as_state_database
-   peer_event_services
-   readwrite
-   gossip
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Troubleshooting and FAQs
-
+   key_concepts
+   tutorials
+   ops_guide
+   command_ref
+   architecture
    Fabric-FAQ
    ordering-service-faq
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contributing
-
    CONTRIBUTING
-   MAINTAINERS
-   jira_navigation
-   dev-setup/devenv
-   dev-setup/build
-   Gerrit/lf-account
-   Gerrit/gerrit
-   Gerrit/changes
-   Gerrit/reviewing
-   Gerrit/best-practices
-   testing
-   Style-guides/go-style
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Appendix
-
    glossary
    releases
    questions

diff --git a/docs/source/key_concepts.rst b/docs/source/key_concepts.rst
@@ -0,0 +1,13 @@
+Key Concepts
+============
+
+.. toctree::
+   :maxdepth: 1
+
+   blockchain
+   functionalities
+   fabric_model
+   identity/identity.md
+   membership/membership.md
+   ledger
+   usecases
diff --git a/docs/source/ops_guide.rst b/docs/source/ops_guide.rst
@@ -0,0 +1,15 @@
+Operations Guides
+=================
+
+.. toctree::
+   :maxdepth: 1
+
+   upgrade_to_one_point_one
+   config_update
+   msp
+   configtx
+   endorsement-policies
+   error-handling
+   logging-control
+   enable_tls
+   kafka
diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst
@@ -0,0 +1,38 @@
+Tutorials
+=========
+
+We offer four initial tutorials to get you started with Hyperledger Fabric.
+The first is oriented to the Hyperledger Fabric **application developer**,
+:doc:`write_first_app`. It takes you through the process of writing your first
+blockchain application for Hyperledger Fabric using the Hyperledger Fabric
+`Node SDK <https://github.com/hyperledger/fabric-sdk-node>`__.
+
+The second tutorial is oriented towards the Hyperledger Fabric network
+operators, :doc:`build_network`. This one walks you through the process of
+establishing a blockchain network using Hyperledger Fabric and provides
+a basic sample application to test it out.
+
+Finally, we offer two chaincode tutorials. One oriented to developers,
+:doc:`chaincode4ade`, and the other oriented to operators,
+:doc:`chaincode4noah`.
+
+.. note:: If you have questions not addressed by this documentation, or run into
+          issues with any of the tutorials, please visit the :doc:`questions`
+          page for some tips on where to find additional help.
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Tutorials
+
+   build_network
+   write_first_app
+   channel_update_tutorial
+   upgrading_your_network_tutorial
+   chaincode
+   chaincode4ade
+   chaincode4noah
+   systemchaincode
+   videos
+
+.. Licensed under Creative Commons Attribution 4.0 International License
+   https://creativecommons.org/licenses/by/4.0/