Skip to content

Commit dc0dfe3

Browse files
committed
[FAB-3906] Fix build errors in the doc.
Fix all the markup errors reported by 'make html' $ cd docs $ make clean $ make html >make.log 2>&1 $ grep ERROR make.log $ Rebased and Fixed a newly introduced error. Change-Id: I9b01167d2782062e82156607b083945cf86b938a Signed-off-by: Arnaud J Le Hors <[email protected]>
1 parent 1cdbfc0 commit dc0dfe3

7 files changed

+48
-45
lines changed

docs/source/FAQ/confidentiality_FAQ.rst

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Confidentiality
22
===============
33

4-
* How is the confidentiality of transactions and business logic achieved?
4+
* How is the confidentiality of transactions and business logic achieved?
55

66
The security module works in conjunction with the membership service
77
module to provide access control service to any data recorded and
@@ -18,8 +18,7 @@ the contents of confidential transactions are encrypted with secret keys
1818
known only to their originators, validators, and authorized auditors.
1919
Only holders of the secret keys can interpret transaction contents.
2020

21-
* What if none of the stakeholders of a business contract are
22-
validators?
21+
* What if none of the stakeholders of a business contract are validators?
2322

2423
In some business scenarios, full confidentiality of contract
2524
logic may be required – such that only contract counterparties and

docs/source/FAQ/identity_management_FAQ.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ Like most other modules on Fabric, you can always replace the
2222
default module with another membership service option should the need
2323
arise.
2424

25-
* Does its Membership Service make Fabric a centralized
26-
solution?
25+
* Does its Membership Service make Fabric a centralized solution?
2726

2827
No. The only role of the Membership Service module is to issue digital
2928
certificates to validated entities that want to participate in the

docs/source/FAQ/usage_FAQ.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ In addition, NV-nodes retain full copies of the ledger, enabling local
1919
queries of the ledger data.
2020

2121
* What does the error string "state may be inconsistent, cannot
22-
query" as a query result mean?
22+
query" as a query result mean?
2323

2424
Sometimes, a validating peer will be out
2525
of sync with the rest of the network. Although determining this

docs/source/abstract_v1.rst

100644100755
+41-37
Original file line numberDiff line numberDiff line change
@@ -36,47 +36,51 @@ regulatory statutes.
3636
WHERE WE'RE GOING
3737
-----------------
3838

39-
| The new architecture introduces a clear functional separation of peer
40-
roles, and allows a transaction to pass through the network in a
41-
structured and modularized fashion.
42-
| The peers are diverged into two distinct roles – Endorser & Committer.
43-
As an endorser, the peer will simulate the transaction and ensure that
44-
the outcome is both deterministic and stable. As a committer, the peer
45-
will validate the integrity of a transaction and then append to the
46-
ledger. Now confidential transactions can be sent to specific
47-
endorsers and their correlating committers, without the broader
48-
network being made cognizant of the transaction. Additionally,
49-
policies can be set to determine what levels of “endorsement” and
50-
“validation” are acceptable for a specific class of transactions.
51-
| A failure to meet these thresholds would simply result in a
52-
transaction being withdrawn or labeled as "invalid", rather than
53-
imploding or stagnating the entire network.
54-
| This new model also introduces the possibility for more elaborate
55-
networks, such as a foreign exchange market. For example, trade
56-
settlement might be contingent upon a mandatory "endorsement" from a
57-
trusted third party (e.g. a clearing house).
58-
59-
| The consensus or "ordering" process (i.e. algorithmic computation) is
60-
entirely abstracted from the peer. This modularity not only provides a
61-
powerful security layer – the ordering nodes are agnostic to the
62-
transaction logic – but it also generates a framework where ordering
63-
can become a pluggable implementation and scalability can truly occur.
64-
| There is no longer a parallel relationship between the number of peers
65-
in a network and the number of orderers. Now networks can grow
66-
dynamically (i.e. add endorsers and committers) without having to add
67-
corresponding orderers, all the while existing in a modular
68-
infrastructure designed to support high transaction throughput.
69-
Moreover, networks now have the capability to completely liberate
70-
themselves from the computational and legal burden of ordering by
71-
tapping into a pre-existing or third party-hosted "ordering service."
39+
The new architecture introduces a clear functional separation of peer
40+
roles, and allows a transaction to pass through the network in a
41+
structured and modularized fashion.
42+
43+
The peers are diverged into two distinct roles – Endorser & Committer.
44+
As an endorser, the peer will simulate the transaction and ensure that
45+
the outcome is both deterministic and stable. As a committer, the peer
46+
will validate the integrity of a transaction and then append to the
47+
ledger. Now confidential transactions can be sent to specific
48+
endorsers and their correlating committers, without the broader
49+
network being made cognizant of the transaction. Additionally,
50+
policies can be set to determine what levels of “endorsement” and
51+
“validation” are acceptable for a specific class of transactions.
52+
53+
A failure to meet these thresholds would simply result in a
54+
transaction being withdrawn or labeled as "invalid", rather than
55+
imploding or stagnating the entire network.
56+
57+
This new model also introduces the possibility for more elaborate
58+
networks, such as a foreign exchange market. For example, trade
59+
settlement might be contingent upon a mandatory "endorsement" from a
60+
trusted third party (e.g. a clearing house).
61+
62+
The consensus or "ordering" process (i.e. algorithmic computation) is
63+
entirely abstracted from the peer. This modularity not only provides a
64+
powerful security layer – the ordering nodes are agnostic to the
65+
transaction logic – but it also generates a framework where ordering
66+
can become a pluggable implementation and scalability can truly occur.
67+
68+
There is no longer a parallel relationship between the number of peers
69+
in a network and the number of orderers. Now networks can grow
70+
dynamically (i.e. add endorsers and committers) without having to add
71+
corresponding orderers, all the while existing in a modular
72+
infrastructure designed to support high transaction throughput.
73+
Moreover, networks now have the capability to completely liberate
74+
themselves from the computational and legal burden of ordering by
75+
tapping into a pre-existing or third party-hosted "ordering service."
7276

7377
As v1.0 manifests, we will see the foundation for interoperable
7478
blockchain networks that have the ability to scale and transact in a
7579
manner adherent with regulatory and industry standards. Watch how fabric
7680
v1.0 and the Hyperledger Project are building a true blockchain for
77-
business -
81+
business.
7882

79-
|HYPERLEDGERv1.0\_ANIMATION|
83+
|FabricV1.0Animation|
8084

8185
HOW TO CONTRIBUTE
8286
-----------------
@@ -104,8 +108,8 @@ that will spawn the capabilities in v1.0:
104108
- Explore the
105109
`documentation <http://hyperledger-fabric.readthedocs.io/en/latest/>`__
106110

107-
.. |HYPERLEDGERv1.0\_ANIMATION| image:: http://img.youtube.com/vi/EKa5Gh9whgU/0.jpg
108-
:target: http://www.youtube.com/watch?v=EKa5Gh9whgU
111+
.. |FabricV1.0Animation| image:: https://img.youtube.com/vi/EKa5Gh9whgU/0.jpg
112+
:target: https://www.youtube.com/watch?v=EKa5Gh9whgU
109113

110114
.. Licensed under Creative Commons Attribution 4.0 International License
111115
https://creativecommons.org/licenses/by/4.0/

docs/source/best_practices.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Best Practices
2-
===========
2+
==============
33

44
Coming soon...
55

docs/source/configtx.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ we use the golang map reference syntax, so
136136

137137
* ``policy1`` maps to ``Channel.Groups["Application"].Policies["policy1"]``
138138
* ``Org1/policy2`` maps to
139-
``Channel.Groups["Application"].Groups["Org1"].Policies["policy2"]``
139+
``Channel.Groups["Application"].Groups["Org1"].Policies["policy2"]``
140140
* ``/Channel/policy3`` maps to ``Channel.Policies["policy3"]``
141141

142142
Note that if a ``mod_policy`` references a policy which does not exist,

docs/source/getting_started.rst

+1
Original file line numberDiff line numberDiff line change
@@ -236,6 +236,7 @@ However, if you want to see this script in action, delete your crypto material
236236
and channel artifacts with the following command:
237237

238238
.. code:: bash
239+
239240
./network_setup.sh down
240241
241242
Now proceed...

0 commit comments

Comments
 (0)