Skip to content

Commit 572dcd5

Browse files
committed
[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]>
1 parent 5afac39 commit 572dcd5

28 files changed

+881
-670
lines changed

docs/source/CONTRIBUTING.rst

+11-11
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,10 @@ If you are a user and you find a bug, please submit an issue using
7272
Please try to provide sufficient information for someone else to reproduce the
7373
issue. One of the project's maintainers should respond to your issue within 24
7474
hours. If not, please bump the issue with a comment and request that it be
75-
reviewed. You can also post to the ``#fabric-maintainers`` channel in
76-
`chat <https://chat.hyperledger.org/channel/fabric-maintainers>`__.
75+
reviewed. You can also post to the relevant fabric channel in
76+
`Hyperledger Rocket Chat <https://chat.hyperledger.org>`__. For example, a doc bug should
77+
be broadcast to ``#fabric-documentation``, a database bug to ``#fabric-ledger``,
78+
and so on...
7779

7880
Fixing issues and working stories
7981
---------------------------------
@@ -247,15 +249,13 @@ designate an initial set of maintainers that will be approved by the
247249
top-level project's existing maintainers when the project is first
248250
approved. The project's maintainers will, from time-to-time, consider
249251
adding or removing a maintainer. An existing maintainer can submit a
250-
change set to the :doc:`MAINTAINERS.rst <MAINTAINERS>` file. If there are
251-
less than eight maintainers, a majority of the existing maintainers on
252-
that project are required to merge the change set. If there are more
253-
than eight existing maintainers, then if five or more of the maintainers
254-
concur with the proposal, the change set is then merged and the
255-
individual is added to (or alternatively, removed from) the maintainers
256-
group. explicit resignation, some infraction of the `code of
257-
conduct <https://wiki.hyperledger.org/community/hyperledger-project-code-of-conduct>`__
258-
or consistently demonstrating poor judgement.
252+
change set to the :doc:`MAINTAINERS.rst <MAINTAINERS>` file. A nominated
253+
Contributor may become a Maintainer by a majority approval of the proposal
254+
by the existing Maintainers. Once approved, the change set is then merged
255+
and the individual is added to (or alternatively, removed from) the maintainers
256+
group. Maintainers may be removed by explicit resignation, or for some
257+
infraction of the `code of conduct <https://wiki.hyperledger.org/community/hyperledger-project-code-of-conduct>`__
258+
or by consistently demonstrating poor judgement.
259259

260260
Legal stuff
261261
-----------

docs/source/Fabric-FAQ.rst

+14
Original file line numberDiff line numberDiff line change
@@ -152,5 +152,19 @@ of native currency is that some amount will get transacted (the chaincode
152152
defining that currency will get called) every time a transaction is processed
153153
on its chain.
154154

155+
Differences in Most Recent Releases
156+
-----------
157+
Q. As part of the v1.0.0 release, what are the highlight differences between v0.6 and v1.0?
158+
159+
A. The differences between any subsequent releases are provided together with the
160+
`Release Notes <http://hyperledger-fabric.readthedocs.io/en/latest/releases.html>`__.
161+
Since Fabric is a pluggable modular framework, you can refer to the `design-docs
162+
<https://wiki.hyperleger.org/projects/fabric/design-docs>`__ for further information of these difference.
163+
164+
Q. Where to get help for the technical questions not answered above?
165+
166+
A. Please use `StackOverflow <https://stackoverflow.com/questions/tagged/hyperledger>`__.
167+
168+
155169
.. Licensed under Creative Commons Attribution 4.0 International License
156170
https://creativecommons.org/licenses/by/4.0/

docs/source/Gerrit/best-practices.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ as a topic in **TopicName** use the following command as an example:
8888

8989
$ git push REMOTE HEAD:refs/for/master/TopicName
9090

91-
The topic will show up in the review :abbr:``UI`` and in the
91+
The topic will show up in the review ``UI`` and in the
9292
``Open Changes List``. Topic branches will disappear from the master
9393
tree when its content is merged.
9494

docs/source/Gerrit/changes.rst

+6-4
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,19 @@ commit file is illustrated below in detail:
4242

4343
::
4444

45-
A short description of your change with no period at the end
45+
[FAB-XXXX] A short description of your change with no period at the end
4646

4747
You can add more details here in several paragraphs, but please keep each line
4848
width less than 80 characters. A bug fix should include the issue number.
4949

50-
Fix Issue # 7050.
51-
5250
Change-Id: IF7b6ac513b2eca5f2bab9728ebd8b7e504d3cebe1
5351
Signed-off-by: Your Name <[email protected]>
5452

55-
Each commit must contain the following line at the bottom of the commit
53+
Include the issue ID in the one line description of your commit message for
54+
readability. Gerrit will link issue IDs automatically to the corresponding
55+
entry in Jira.
56+
57+
Each commit must also contain the following line at the bottom of the commit
5658
message:
5759

5860
::

docs/source/arch-deep-dive.rst

+8-12
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ transactions for inclusion in the blockchain state.
229229

230230
**Partitioning (ordering service channels).** Ordering service may
231231
support multiple *channels* similar to the *topics* of a
232-
publish/subscribe (pub/sub) messaging system. Clients can connects to a
232+
publish/subscribe (pub/sub) messaging system. Clients can connect to a
233233
given channel and can then send messages and obtain the messages that
234234
arrive. Channels can be thought of as partitions - clients connecting to
235235
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,
590590
all peers commit and apply the same sequence of transactions and update
591591
their state in the same way.
592592

593-
.. figure:: http://vukolic.com/hyperledger/flow-4.png
593+
.. image:: images/flow-4.png
594594
:alt: Illustration of the transaction flow (common-case path).
595595

596-
Illustration of the transaction flow (common-case path).
597-
598-
Figure 1. Illustration of one possible transaction flow (common-case
599-
path).
596+
*Figure 1. Illustration of one possible transaction flow (common-case path).*
600597

601598
3. Endorsement policies
602599
-----------------------
@@ -723,11 +720,12 @@ peer does this by itself (e.g., by using the bitmask associated with
723720
``PeerLedger``). A vBlock is defined as a block without the invalid
724721
transactions, that have been filtered out. Such vBlocks are inherently
725722
dynamic in size and may be empty. An illustration of vBlock construction
726-
is given in the figure below. |Illustration of the transaction flow
727-
(common-case path).|
723+
is given in the figure below.
724+
725+
.. image:: images/blocks-3.png
726+
:alt: Illustration of vBlock formation
728727

729-
Figure 2. Illustration of validated ledger block (vBlock) formation from
730-
ledger (``PeerLedger``) blocks.
728+
*Figure 2. Illustration of validated ledger block (vBlock) formation from ledger (PeerLedger) blocks.*
731729

732730
vBlocks are chained together to a hash chain by every peer. More
733731
specifically, every block of a validated ledger contains:
@@ -828,7 +826,5 @@ also be combined:
828826
checkpoint if confirmed by *f+1* different peers collocated with
829827
orderers.
830828

831-
.. |Illustration of the transaction flow (common-case path).| image:: http://vukolic.com/hyperledger/blocks-3.png
832-
833829
.. Licensed under Creative Commons Attribution 4.0 International License
834830
https://creativecommons.org/licenses/by/4.0/

docs/source/blockchain.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -140,15 +140,15 @@ blockchain technologies via a community process, with intellectual property
140140
rights that encourage open development and the adoption of key standards over
141141
time.
142142

143-
Hyperledger Fabric is a one of the blockchain projects within Hyperledger.
143+
Hyperledger Fabric is one of the blockchain projects within Hyperledger.
144144
Like other blockchain technologies, it has a ledger, uses smart contracts,
145145
and is a system by which participants manage their transactions.
146146

147147
Where Hyperledger Fabric breaks from some other blockchain systems is that
148-
it is **private** and **permissioned**. Rather than the “proof of work” some
149-
blockchain networks use to verify identity (allowing anyone who meets those
150-
criteria to join the network), the members of a Hyperledger Fabric network
151-
enroll through a **membership services provider**.
148+
it is **private** and **permissioned**. Rather than an open permissionless system
149+
that allows unknown identities to participate in the network (requiring protocols
150+
like Proof of Work to validate transactions and secure the network), the members
151+
of a Hyperledger Fabric network enroll through a **Membership Service Provider (MSP)**.
152152

153153
Hyperledger Fabric also offers several pluggable options. Ledger data can be
154154
stored in multiple formats, consensus mechanisms can be switched in and out,

0 commit comments

Comments
 (0)