[FAB-6592] Update docs in release branch

We currently publish docs from master as latest. But with 1.1 on the horizon, we need to version our docs in RTD using branches and tags. Change-Id: I0a1e65761e7c5532349bc25f467825a383ed4c54 Signed-off-by: Gari Singh <[email protected]>
hyperledger · Oct 12, 2017 · 572dcd5 · 572dcd5
1 parent 5afac39
commit 572dcd5
Show file tree

Hide file tree

Showing 28 changed files with 881 additions and 670 deletions.
diff --git a/docs/source/CONTRIBUTING.rst b/docs/source/CONTRIBUTING.rst
@@ -72,8 +72,10 @@ If you are a user and you find a bug, please submit an issue using
 Please try to provide sufficient information for someone else to reproduce the
 issue. One of the project's maintainers should respond to your issue within 24
 hours. If not, please bump the issue with a comment and request that it be
-reviewed. You can also post to the ``#fabric-maintainers`` channel in
-`chat <https://chat.hyperledger.org/channel/fabric-maintainers>`__.
+reviewed. You can also post to the relevant fabric channel in
+`Hyperledger Rocket Chat <https://chat.hyperledger.org>`__.  For example, a doc bug should
+be broadcast to ``#fabric-documentation``, a database bug to ``#fabric-ledger``,
+and so on... 
 
 Fixing issues and working stories
 ---------------------------------
@@ -247,15 +249,13 @@ designate an initial set of maintainers that will be approved by the
 top-level project's existing maintainers when the project is first
 approved. The project's maintainers will, from time-to-time, consider
 adding or removing a maintainer. An existing maintainer can submit a
-change set to the :doc:`MAINTAINERS.rst <MAINTAINERS>` file. If there are
-less than eight maintainers, a majority of the existing maintainers on
-that project are required to merge the change set. If there are more
-than eight existing maintainers, then if five or more of the maintainers
-concur with the proposal, the change set is then merged and the
-individual is added to (or alternatively, removed from) the maintainers
-group. explicit resignation, some infraction of the `code of
-conduct <https://wiki.hyperledger.org/community/hyperledger-project-code-of-conduct>`__
-or consistently demonstrating poor judgement.
+change set to the :doc:`MAINTAINERS.rst <MAINTAINERS>` file. A nominated
+Contributor may become a Maintainer by a majority approval of the proposal
+by the existing Maintainers. Once approved, the change set is then merged
+and the individual is added to (or alternatively, removed from) the maintainers
+group. Maintainers may be removed by explicit resignation, or for some
+infraction of the `code of conduct <https://wiki.hyperledger.org/community/hyperledger-project-code-of-conduct>`__
+or by consistently demonstrating poor judgement.
 
 Legal stuff
 -----------

diff --git a/docs/source/Fabric-FAQ.rst b/docs/source/Fabric-FAQ.rst
@@ -152,5 +152,19 @@ of native currency is that some amount will get transacted (the chaincode
 defining that currency will get called) every time a transaction is processed
 on its chain.
 
+Differences in Most Recent Releases
+-----------
+Q. As part of the v1.0.0 release, what are the highlight differences between v0.6 and v1.0?
+
+A. The differences between any subsequent releases are provided together with the
+`Release Notes <http://hyperledger-fabric.readthedocs.io/en/latest/releases.html>`__.
+Since Fabric is a pluggable modular framework, you can refer to the `design-docs
+<https://wiki.hyperleger.org/projects/fabric/design-docs>`__ for further information of these difference.
+
+Q. Where to get help for the technical questions not answered above?
+
+A. Please use `StackOverflow <https://stackoverflow.com/questions/tagged/hyperledger>`__.
+
+
 .. Licensed under Creative Commons Attribution 4.0 International License
    https://creativecommons.org/licenses/by/4.0/
diff --git a/docs/source/Gerrit/best-practices.rst b/docs/source/Gerrit/best-practices.rst
@@ -88,7 +88,7 @@ as a topic in **TopicName** use the following command as an example:
 
 $ git push REMOTE HEAD:refs/for/master/TopicName
 
-The topic will show up in the review :abbr:``UI`` and in the
+The topic will show up in the review ``UI`` and in the
 ``Open Changes List``. Topic branches will disappear from the master
 tree when its content is merged.
 

diff --git a/docs/source/Gerrit/changes.rst b/docs/source/Gerrit/changes.rst
@@ -42,17 +42,19 @@ commit file is illustrated below in detail:
 
 ::
 
-    A short description of your change with no period at the end
+    [FAB-XXXX] A short description of your change with no period at the end
 
     You can add more details here in several paragraphs, but please keep each line
     width less than 80 characters. A bug fix should include the issue number.
 
-    Fix Issue # 7050.
-
     Change-Id: IF7b6ac513b2eca5f2bab9728ebd8b7e504d3cebe1
     Signed-off-by: Your Name <[email protected]>
 
-Each commit must contain the following line at the bottom of the commit
+Include the issue ID in the one line description of your commit message for
+readability. Gerrit will link issue IDs automatically to the corresponding
+entry in Jira.
+
+Each commit must also contain the following line at the bottom of the commit
 message:
 
 ::

diff --git a/docs/source/arch-deep-dive.rst b/docs/source/arch-deep-dive.rst
@@ -229,7 +229,7 @@ transactions for inclusion in the blockchain state.
 
 **Partitioning (ordering service channels).** Ordering service may
 support multiple *channels* similar to the *topics* of a
-publish/subscribe (pub/sub) messaging system. Clients can connects to a
+publish/subscribe (pub/sub) messaging system. Clients can connect to a
 given channel and can then send messages and obtain the messages that
 arrive. Channels can be thought of as partitions - clients connecting to
 one channel are unaware of the existence of other channels, but clients
@@ -590,13 +590,10 @@ conclusion whether a transaction contained in a blob is valid. Hence,
 all peers commit and apply the same sequence of transactions and update
 their state in the same way.
 
-.. figure:: http://vukolic.com/hyperledger/flow-4.png
+.. image:: images/flow-4.png
    :alt: Illustration of the transaction flow (common-case path).
 
-   Illustration of the transaction flow (common-case path).
-
-Figure 1. Illustration of one possible transaction flow (common-case
-path).
+*Figure 1. Illustration of one possible transaction flow (common-case path).*
 
 3. Endorsement policies
 -----------------------
@@ -723,11 +720,12 @@ peer does this by itself (e.g., by using the bitmask associated with
 ``PeerLedger``). A vBlock is defined as a block without the invalid
 transactions, that have been filtered out. Such vBlocks are inherently
 dynamic in size and may be empty. An illustration of vBlock construction
-is given in the figure below. |Illustration of the transaction flow
-(common-case path).|
+is given in the figure below.
+
+.. image:: images/blocks-3.png
+   :alt: Illustration of vBlock formation
 
-Figure 2. Illustration of validated ledger block (vBlock) formation from
-ledger (``PeerLedger``) blocks.
+*Figure 2. Illustration of validated ledger block (vBlock) formation from ledger (PeerLedger) blocks.*
 
 vBlocks are chained together to a hash chain by every peer. More
 specifically, every block of a validated ledger contains:
@@ -828,7 +826,5 @@ also be combined:
       checkpoint if confirmed by *f+1* different peers collocated with
       orderers.
 
-.. |Illustration of the transaction flow (common-case path).| image:: http://vukolic.com/hyperledger/blocks-3.png
-
 .. Licensed under Creative Commons Attribution 4.0 International License
    https://creativecommons.org/licenses/by/4.0/
diff --git a/docs/source/blockchain.rst b/docs/source/blockchain.rst
@@ -140,15 +140,15 @@ blockchain technologies via a community process, with intellectual property
 rights that encourage open development and the adoption of key standards over
 time.
 
-Hyperledger Fabric is a one of the blockchain projects within Hyperledger.
+Hyperledger Fabric is one of the blockchain projects within Hyperledger.
 Like other blockchain technologies, it has a ledger, uses smart contracts,
 and is a system by which participants manage their transactions.
 
 Where Hyperledger Fabric breaks from some other blockchain systems is that
-it is **private** and **permissioned**. Rather than the “proof of work” some
-blockchain networks use to verify identity (allowing anyone who meets those
-criteria to join the network), the members of a Hyperledger Fabric network
-enroll through a **membership services provider**.
+it is **private** and **permissioned**. Rather than an open permissionless system
+that allows unknown identities to participate in the network (requiring protocols
+like Proof of Work to validate transactions and secure the network), the members
+of a Hyperledger Fabric network enroll through a **Membership Service Provider (MSP)**.
 
 Hyperledger Fabric also offers several pluggable options. Ledger data can be
 stored in multiple formats, consensus mechanisms can be switched in and out,