Skip to content

Commit 9a86c1a

Browse files
committed
FAB-5166 Docs should use Hyperledger Fabric
There are still several places in the docs which do not properly use Hyperledger Fabric when referring to Hyperledger Fabric. While this change covers a lot of files, it simply changes all reference to Hyperledger Fabric or provides a minor rewrite to avoid using the terms at all. As part of this, also addressed - FAB-5014 - FAB-5139 - Changed docker to Docker as appropriate - Other minor cleanups since this included most of the docs Change-Id: I7818a44b1411abb536a595c537202615bf901199 Signed-off-by: Gari Singh <[email protected]>
1 parent b8e189e commit 9a86c1a

31 files changed

+175
-221
lines changed

docs/source/CONTRIBUTING.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Discussion of the proposed feature should be conducted in the JIRA issue itself,
111111
so that we have a consistent pattern within our community as to where to find
112112
design discussion.
113113

114-
Getting the support of three or more of the Fabric maintainers for the new
114+
Getting the support of three or more of the Hyperledger Fabric maintainers for the new
115115
feature will greatly enhance the probability that the feature's related CRs
116116
will be merged.
117117

@@ -133,7 +133,7 @@ Next, try :doc:`building the project <dev-setup/build>` in your local
133133
development environment to ensure that everything is set up correctly.
134134

135135
The :doc:`logging-control` document describes how to tweak
136-
the logging levels of various components within the Fabric. Finally,
136+
the logging levels of various components within Hyperledger Fabric. Finally,
137137
every source file needs to include a
138138
`license header <https://github.com/hyperledger/fabric/blob/master/docs/source/dev-setup/headers.txt>`__: modified to include a copyright
139139
statement for the principle author(s).

docs/source/Fabric-FAQ.rst

-35
Original file line numberDiff line numberDiff line change
@@ -154,40 +154,5 @@ of native currency is that some amount will get transacted (the chaincode
154154
defining that currency will get called) every time a transaction is processed
155155
on its chain.
156156

157-
Identity Management (Membership Service)
158-
----------------------------------------
159-
160-
Q. What is unique about the Hyperledger Fabric's membership service module?
161-
162-
A. One of the things that makes the membership service module stand out from
163-
the pack is our implementation of the latest advances in cryptography.
164-
165-
In addition to ensuring private, auditable transactions, our membership
166-
service module introduces the concept of enrollment and transaction
167-
certificates. This innovation ensures that only verified owners can
168-
create asset tokens, allowing an infinite number of transaction
169-
certificates to be issued through parent enrollment certificates while
170-
guaranteeing the private keys of asset tokens can be regenerated if
171-
lost.
172-
173-
Issuers also have the ability revoke transaction certificates or
174-
designate them to expire within a certain timeframe, allowing greater
175-
control over the asset tokens they have issued.
176-
177-
Like most other modules, you can always replace the
178-
default module with another membership service option should the need
179-
arise.
180-
181-
Q. Does its Membership Service make Fabric a centralized solution?
182-
183-
A. No. The only role of the Membership Service module is to issue digital
184-
certificates to validated entities that want to participate in the
185-
network. It does not execute transactions nor is it aware of how or when
186-
these certificates are used in any particular network.
187-
188-
However, because certificates are the way networks regulate and manage
189-
their users, the module serves a central regulatory and organizational
190-
role.
191-
192157
.. Licensed under Creative Commons Attribution 4.0 International License
193158
https://creativecommons.org/licenses/by/4.0/

docs/source/Gerrit/lf-account.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Requesting a Linux Foundation Account
22
=====================================
33

4-
Contributions to the Fabric code base require a Linux Foundation
4+
Contributions to the Hyperledger Fabric code base require a Linux Foundation
55
account. Follow the steps below to create a Linux Foundation account.
66

77
Creating a Linux Foundation ID

docs/source/Style-guides/go-style.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ generate/update the respective ``.pb.go`` files.
2626
Adding or updating Go packages
2727
------------------------------
2828

29-
The Hyperledger Fabric Project uses Go 1.6 vendoring for package
29+
The Hyperledger Fabric Project uses Govendor for package
3030
management. This means that all required packages reside in the
31-
``vendor`` folder within the fabric project. Go will use packages in
32-
this folder instead of the GOPATH when the ``go install`` or
31+
``$GOPATH/src/github.com/hyperledger/fabric/vendor`` folder. Go will use
32+
packages in this folder instead of the GOPATH when the ``go install`` or
3333
``go build`` commands are executed. To manage the packages in the
3434
``vendor`` folder, we use
3535
`Govendor <https://github.com/kardianos/govendor>`__, which is installed

docs/source/arch-deep-dive.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -234,8 +234,8 @@ 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
236236
may connect to multiple channels. Even though some ordering service
237-
implementations included with Hyperledger Fabric v1 will support
238-
multiple channels, for simplicity of presentation, in the rest of this
237+
implementations included with Hyperledger Fabric support multiple
238+
channels, for simplicity of presentation, in the rest of this
239239
document, we assume ordering service consists of a single channel/topic.
240240

241241
**Ordering service API.** Peers connect to the channel provided by the

docs/source/architecture.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ only to the set of nodes participating in that channel.
2222

2323
The Hyperledger Fabric architecture is comprised of the following
2424
components: peer nodes, ordering nodes and the clients applications that
25-
are likely leveraging one of the language-specific Fabric SDKs. These
26-
components have identities derived from certificate authorities.
25+
are likely leveraging one of the language-specific Hyperledger Fabric SDKs.
26+
These components have identities derived from certificate authorities.
2727
Hyperledger Fabric also offers a certificate authority service,
2828
*fabric-ca* but, you may substitute that with your own.
2929

docs/source/blockchain.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -147,12 +147,12 @@ and is a system by which participants manage their transactions.
147147
Where Hyperledger Fabric breaks from some other blockchain systems is that
148148
it is **private** and **permissioned**. Rather than the “proof of work” some
149149
blockchain networks use to verify identity (allowing anyone who meets those
150-
criteria to join the network), the members of a Fabric network enroll through
151-
a **membership services provider**.
150+
criteria to join the network), the members of a Hyperledger Fabric network
151+
enroll through a **membership services provider**.
152152

153-
Fabric also offers several pluggable options. Ledger data can be stored in
154-
multiple formats, consensus mechanisms can be switched in and out,
155-
and different membership service providers are supported.
153+
Hyperledger Fabric also offers several pluggable options. Ledger data can be
154+
stored in multiple formats, consensus mechanisms can be switched in and out,
155+
and different MSPs are supported.
156156

157157
Hyperledger Fabric also offers the ability to create **channels**, allowing a group of
158158
participants to create a separate ledger of transactions. This is an especially

docs/source/build_network.rst

+30-28
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@ Building Your First Network
22
===========================
33

44
.. note:: These instructions have been verified to work against the
5-
version "1.0.0-rc1" tagged docker images and the pre-compiled
5+
version "1.0.0-rc1" tagged Docker images and the pre-compiled
66
setup utilities within the supplied tar file. If you run
77
these commands with images or tools from the current master
88
branch, it is possible that you will see configuration and panic
99
errors.
1010

11-
The build your first network (BYFN) scenario provisions a sample Fabric network
12-
consisting of two organizations, each maintaining two peer nodes, and a "solo"
13-
ordering service.
11+
The build your first network (BYFN) scenario provisions a sample Hyperledger
12+
Fabric network consisting of two organizations, each maintaining two peer
13+
nodes, and a "solo" ordering service.
1414

1515
Install prerequisites
1616
---------------------
@@ -38,12 +38,12 @@ sub-directory now.
3838
Want to run it now?
3939
-------------------
4040
41-
We provide a fully annotated script ``byfn.sh`` that leverages these docker
42-
images to quickly bootstrap a Fabric network comprised of 4 peers representing
43-
two different organizations, and an orderer node. It will also launch a
44-
container to run a scripted execution that will join peers to a channel, deploy
45-
and instantiate chaincode and drive execution of transactions against the
46-
deployed chaincode.
41+
We provide a fully annotated script ``byfn.sh`` that leverages these Docker
42+
images to quickly bootstrap a Hyperledger Fabric network comprised of 4 peers
43+
representing two different organizations, and an orderer node. It will also
44+
launch a container to run a scripted execution that will join peers to a
45+
channel, deploy and instantiate chaincode and drive execution of transactions
46+
against the deployed chaincode.
4747

4848
Here's the help text for the ``byfn.sh`` script:
4949

@@ -213,7 +213,7 @@ Once again, you will be prompted to continue, respond with a ``y``:
213213
214214
If you'd like to learn more about the underlying tooling and bootstrap mechanics,
215215
continue reading. In these next sections we'll walk through the various steps
216-
and requirements to build a fully-functional Fabric network.
216+
and requirements to build a fully-functional Hyperledger Fabric network.
217217

218218
Crypto Generator
219219
----------------
@@ -229,15 +229,17 @@ How does it work?
229229
Cryptogen consumes a file - ``crypto-config.yaml`` - that contains the network
230230
topology and allows us to generate a set of certificates and keys for both the
231231
Organizations and the components that belong to those Organizations. Each
232-
Organization is provisioned a unique root certificate (``ca-cert``), that binds
232+
Organization is provisioned a unique root certificate (``ca-cert``) that binds
233233
specific components (peers and orderers) to that Org. By assigning each
234234
Organization a unique CA certificate, we are mimicking a typical network where
235235
a participating :ref:`Member` would use its own Certificate Authority.
236-
Transactions and communications within Fabric are signed by an entity's private
237-
key (``keystore``), and then verified by means of a public key (``signcerts``).
238-
You will notice a "count" variable within this file. We use this to specify
239-
the number of peers per Organization; in our case it's two peers per Org. We
240-
won't delve into the minutiae of `x.509 certificates and public key
236+
Transactions and communications within Hyperledger Fabric are signed by an
237+
entity's private key (``keystore``), and then verified by means of a public
238+
key (``signcerts``).
239+
240+
You will notice a ``count`` variable within this file. We use this to specify
241+
the number of peers per Organization; in our case there are two peers per Org.
242+
We won't delve into the minutiae of `x.509 certificates and public key
241243
infrastructure <https://en.wikipedia.org/wiki/Public_key_infrastructure>`__
242244
right now. If you're interested, you can peruse these topics on your own time.
243245

@@ -284,7 +286,7 @@ Configuration Transaction Generator
284286
The ``configtxgen tool`` is used to create four configuration artifacts:
285287

286288
* orderer ``genesis block``,
287-
* fabric ``channel configuration transaction``,
289+
* channel ``channel configuration transaction``,
288290
* and two ``anchor peer transactions`` - one for each Peer Org.
289291

290292
Please see :doc:`configtxgen` for a complete description of the use of this
@@ -677,7 +679,7 @@ traditional transaction - read/write - is performed against that chaincode (e.g.
677679
the value of "a"). The transaction causes the container to start. Also,
678680
all peers in a channel maintain an exact copy of the ledger which
679681
comprises the blockchain to store the immutable, sequenced record in
680-
blocks, as well as a state database to maintain current fabric state.
682+
blocks, as well as a state database to maintain a snapshot of the current state.
681683
This includes those peers that do not have chaincode installed on them
682684
(like ``peer1.org1.example.com`` in the above example) . Finally, the chaincode is accessible
683685
after it is installed (like ``peer1.org2.example.com`` in the above example) because it
@@ -686,7 +688,7 @@ has already been instantiated.
686688
How do I see these transactions?
687689
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
688690

689-
Check the logs for the CLI docker container.
691+
Check the logs for the CLI Docker container.
690692

691693
.. code:: bash
692694
@@ -741,17 +743,17 @@ output from each container:
741743
ex02 Invoke
742744
Query Response:{"Name":"a","Amount":"90"}
743745
744-
Understanding the docker-compose topology
746+
Understanding the Docker Compose topology
745747
-----------------------------------------
746748

747-
The BYFN sample offers us two flavors of docker-compose files, both of which
749+
The BYFN sample offers us two flavors of Docker Compose files, both of which
748750
are extended from the ``docker-compose-base.yaml`` (located in the ``base``
749751
folder). Our first flavor, ``docker-compose-cli.yaml``, provides us with a
750-
CLI container, along with an orderer, four peers. We use this docker-compose
752+
CLI container, along with an orderer, four peers. We use this file
751753
for the entirety of the instructions on this page.
752754

753755
.. note:: the remainder of this section covers a docker-compose file designed for the
754-
SDK. Refer to the `Node.js SDK <https://github.com/hyperledger/fabric-sdk-node>`__
756+
SDK. Refer to the `Node SDK <https://github.com/hyperledger/fabric-sdk-node>`__
755757
repo for details on running these tests.
756758

757759
The second flavor, ``docker-compose-e2e.yaml``, is constructed to run end-to-end tests
@@ -782,7 +784,7 @@ data content contingent upon the chaincode data being modeled as JSON.
782784

783785
To use CouchDB instead of the default database (goleveldb), follow the same
784786
procedures outlined earlier for generating the artifacts, except when starting
785-
the network pass the couchdb docker-compose as well:
787+
the network pass ``docker-compose-couch.yaml`` as well:
786788

787789
.. code:: bash
788790
@@ -910,8 +912,8 @@ Troubleshooting
910912
911913
- **YOU WILL SEE ERRORS IF YOU DO NOT REMOVE CONTAINERS AND IMAGES**
912914

913-
- If you see docker errors, first check your version (should be 1.12 or above),
914-
and then try restarting your docker process. Problems with Docker are
915+
- If you see Docker errors, first check your version (should be 1.12 or above),
916+
and then try restarting your Docker process. Problems with Docker are
915917
oftentimes not immediately recognizable. For example, you may see errors
916918
resulting from an inability to access crypto material mounted within a
917919
container.
@@ -970,7 +972,7 @@ channel artifacts.
970972
./byfn.sh -m down
971973
972974
- If you see an error stating that you still have "active endpoints", then prune
973-
your docker networks. This will wipe your previous networks and start you with a
975+
your Docker networks. This will wipe your previous networks and start you with a
974976
fresh environment:
975977

976978
.. code:: bash

docs/source/capabilities.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ Hyperledger Fabric Capabilities
33

44
Hyperledger Fabric is a unique implementation of distributed ledger technology
55
(DLT) that delivers enterprise-ready network security, scalability,
6-
confidentiality and performance, in a modular blockchain architecture. The
7-
fabric delivers the following blockchain network capabilities:
6+
confidentiality and performance, in a modular blockchain architecture.
7+
Hyperledger Fabric delivers the following blockchain network capabilities:
88

99
Identity management
1010
-------------------
@@ -65,11 +65,11 @@ Modular design
6565
Hyperledger Fabric implements a modular architecture to
6666
provide functional choice to network designers. Specific algorithms for
6767
identity, ordering (consensus) and encryption, for example, can be plugged in
68-
to any fabric network. The result is a universal blockchain architecture that
69-
any industry or public domain can adopt, with the assurance that its networks
70-
will be interoperable across market, regulatory and geographic boundaries. By
71-
contrast, current alternatives to Hyperledger Fabric are largely partisan,
72-
constrained and industry-specific.
68+
to any Hyperledger Fabric network. The result is a universal blockchain
69+
architecture that any industry or public domain can adopt, with the assurance
70+
that its networks will be interoperable across market, regulatory and
71+
geographic boundaries. By contrast, current alternatives to Hyperledger Fabric
72+
are largely partisan, constrained and industry-specific.
7373

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

docs/source/chaincode.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ We offer two different perspectives on chaincode. One, from the perspective of
2424
an application developer developing a blockchain application/solution
2525
entitled :doc:`chaincode4ade`, and the other, :doc:`chaincode4noah` oriented
2626
to the blockchain network operator who is responsible for managing a blockchain
27-
network, and who would leverage the Fabric API to install, instantiate, and
28-
upgrade chaincode, but would likely not be involved in the development of a
29-
chaincode application.
27+
network, and who would leverage the Hyperledger Fabric API to install,
28+
instantiate, and upgrade chaincode, but would likely not be involved in the
29+
development of a chaincode application.
3030

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

docs/source/chaincode4ade.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,7 @@ We start "dev mode" by leveraging pre-generated orderer and channel artifacts fo
382382
a sample dev network. As such, the user can immediately jump into the process
383383
of compiling chaincode and driving calls.
384384

385-
Install Fabric Samples
385+
Install Hyperledger Fabric Samples
386386
----------------------
387387

388388
If you haven't already done so, please install the :doc:`samples`.
@@ -394,10 +394,10 @@ clone:
394394
395395
cd chaincode-docker-devmode
396396
397-
Download docker images
397+
Download Docker images
398398
----------------------
399399

400-
We need four docker images in order for "dev mode" to run against the supplied
400+
We need four Docker images in order for "dev mode" to run against the supplied
401401
docker compose script. If you installed the ``fabric-samples`` repo clone and
402402
followed the instructions to :ref:`download-platform-specific-binaries`, then
403403
you should have the necessary Docker images installed locally.

docs/source/chaincode4noah.rst

+6-5
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ The Hyperledger Fabric API enables interaction with the various nodes
3030
in a blockchain network - the peers, orderers and MSPs - and it also allows
3131
one to package, install, instantiate and upgrade chaincode on the endorsing
3232
peer nodes. The Hyperledger Fabric language-specific SDKs
33-
abstract the specifics of the Hyperledger Fabric's API to facilitate
33+
abstract the specifics of the Hyperledger Fabric API to facilitate
3434
application development, though it can be used to manage a chaincode's
35-
lifecycle. Additionally, the Hyperledger Fabric's API can be accessed
35+
lifecycle. Additionally, the Hyperledger Fabric API can be accessed
3636
directly via the CLI, which we will use in this document.
3737

3838
We provide four commands to manage a chaincode's lifecycle: ``package``,
@@ -307,7 +307,7 @@ CLI
307307
can simply invoke the commands from within a running docker container.
308308

309309
To view the currently available CLI commands, execute the following command from
310-
within a running ``fabric-peer`` docker container:
310+
within a running ``fabric-peer`` Docker container:
311311

312312
.. code:: bash
313313
@@ -384,8 +384,9 @@ register with a `fixed set of parameters
384384
compiled in and doesn't have endorsement policies or endorsement policy
385385
functionality.
386386

387-
System chaincode is used in Fabric to implement a number of system behaviors
388-
so that they can be replaced or modified as appropriate by a system integrator.
387+
System chaincode is used in Hyperledger Fabric to implement a number of
388+
system behaviors so that they can be replaced or modified as appropriate
389+
by a system integrator.
389390

390391
The current list of system chaincodes:
391392

docs/source/configtxgen.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Channel Configuration (configtxgen)
22
===================================
33

44
This document describe the usage for the ``configtxgen`` utility for
5-
manipulating fabric channel configuration.
5+
manipulating Hyperledger Fabric channel configuration.
66

77
For now, the tool is primarily focused on generating the genesis block
88
for bootstrapping the orderer, but it is intended to be enhanced in the

docs/source/dev-setup/build.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
Building the fabric
2-
-------------------
1+
Building Hyperledger Fabric
2+
---------------------------
33

44
The following instructions assume that you have already set up your
55
:doc:`development environment <devenv>`.
66

7-
To build the Fabric:
7+
To build Hyperledger Fabric:
88

99
::
1010

@@ -165,7 +165,7 @@ The available log levels in order of increasing verbosity are: *CRITICAL
165165

166166
See the :doc:`logging-control` document for
167167
instructions on tweaking the level of log messages to output when running
168-
the various Fabric components.
168+
the various Hyperledger Fabric components.
169169

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

0 commit comments

Comments
 (0)