Skip to content

Commit

Permalink
FAB-5166 Docs should use Hyperledger Fabric
Browse files Browse the repository at this point in the history
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 <gari.r.singh@gmail.com>
  • Loading branch information
mastersingh24 committed Jul 4, 2017
1 parent b8e189e commit 9a86c1a
Show file tree
Hide file tree
Showing 31 changed files with 175 additions and 221 deletions.
4 changes: 2 additions & 2 deletions docs/source/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Discussion of the proposed feature should be conducted in the JIRA issue itself,
so that we have a consistent pattern within our community as to where to find
design discussion.

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

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

The :doc:`logging-control` document describes how to tweak
the logging levels of various components within the Fabric. Finally,
the logging levels of various components within Hyperledger Fabric. Finally,
every source file needs to include a
`license header <https://github.com/hyperledger/fabric/blob/master/docs/source/dev-setup/headers.txt>`__: modified to include a copyright
statement for the principle author(s).
Expand Down
35 changes: 0 additions & 35 deletions docs/source/Fabric-FAQ.rst
Original file line number Diff line number Diff line change
Expand Up @@ -154,40 +154,5 @@ 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.

Identity Management (Membership Service)
----------------------------------------

Q. What is unique about the Hyperledger Fabric's membership service module?

A. One of the things that makes the membership service module stand out from
the pack is our implementation of the latest advances in cryptography.

In addition to ensuring private, auditable transactions, our membership
service module introduces the concept of enrollment and transaction
certificates. This innovation ensures that only verified owners can
create asset tokens, allowing an infinite number of transaction
certificates to be issued through parent enrollment certificates while
guaranteeing the private keys of asset tokens can be regenerated if
lost.

Issuers also have the ability revoke transaction certificates or
designate them to expire within a certain timeframe, allowing greater
control over the asset tokens they have issued.

Like most other modules, you can always replace the
default module with another membership service option should the need
arise.

Q. Does its Membership Service make Fabric a centralized solution?

A. No. The only role of the Membership Service module is to issue digital
certificates to validated entities that want to participate in the
network. It does not execute transactions nor is it aware of how or when
these certificates are used in any particular network.

However, because certificates are the way networks regulate and manage
their users, the module serves a central regulatory and organizational
role.

.. Licensed under Creative Commons Attribution 4.0 International License
https://creativecommons.org/licenses/by/4.0/
2 changes: 1 addition & 1 deletion docs/source/Gerrit/lf-account.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Requesting a Linux Foundation Account
=====================================

Contributions to the Fabric code base require a Linux Foundation
Contributions to the Hyperledger Fabric code base require a Linux Foundation
account. Follow the steps below to create a Linux Foundation account.

Creating a Linux Foundation ID
Expand Down
6 changes: 3 additions & 3 deletions docs/source/Style-guides/go-style.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ generate/update the respective ``.pb.go`` files.
Adding or updating Go packages
------------------------------

The Hyperledger Fabric Project uses Go 1.6 vendoring for package
The Hyperledger Fabric Project uses Govendor for package
management. This means that all required packages reside in the
``vendor`` folder within the fabric project. Go will use packages in
this folder instead of the GOPATH when the ``go install`` or
``$GOPATH/src/github.com/hyperledger/fabric/vendor`` folder. Go will use
packages in this folder instead of the GOPATH when the ``go install`` or
``go build`` commands are executed. To manage the packages in the
``vendor`` folder, we use
`Govendor <https://github.com/kardianos/govendor>`__, which is installed
Expand Down
4 changes: 2 additions & 2 deletions docs/source/arch-deep-dive.rst
Original file line number Diff line number Diff line change
Expand Up @@ -234,8 +234,8 @@ 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
may connect to multiple channels. Even though some ordering service
implementations included with Hyperledger Fabric v1 will support
multiple channels, for simplicity of presentation, in the rest of this
implementations included with Hyperledger Fabric support multiple
channels, for simplicity of presentation, in the rest of this
document, we assume ordering service consists of a single channel/topic.

**Ordering service API.** Peers connect to the channel provided by the
Expand Down
4 changes: 2 additions & 2 deletions docs/source/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ only to the set of nodes participating in that channel.

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

Expand Down
10 changes: 5 additions & 5 deletions docs/source/blockchain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -147,12 +147,12 @@ 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 Fabric network enroll through
a **membership services provider**.
criteria to join the network), the members of a Hyperledger Fabric network
enroll through a **membership services provider**.

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

Hyperledger Fabric also offers the ability to create **channels**, allowing a group of
participants to create a separate ledger of transactions. This is an especially
Expand Down
58 changes: 30 additions & 28 deletions docs/source/build_network.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@ Building Your First Network
===========================

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

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

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

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

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

Crypto Generator
----------------
Expand All @@ -229,15 +229,17 @@ How does it work?
Cryptogen consumes a file - ``crypto-config.yaml`` - that contains the network
topology and allows us to generate a set of certificates and keys for both the
Organizations and the components that belong to those Organizations. Each
Organization is provisioned a unique root certificate (``ca-cert``), that binds
Organization is provisioned a unique root certificate (``ca-cert``) that binds
specific components (peers and orderers) to that Org. By assigning each
Organization a unique CA certificate, we are mimicking a typical network where
a participating :ref:`Member` would use its own Certificate Authority.
Transactions and communications within Fabric are signed by an entity's private
key (``keystore``), and then verified by means of a public key (``signcerts``).
You will notice a "count" variable within this file. We use this to specify
the number of peers per Organization; in our case it's two peers per Org. We
won't delve into the minutiae of `x.509 certificates and public key
Transactions and communications within Hyperledger Fabric are signed by an
entity's private key (``keystore``), and then verified by means of a public
key (``signcerts``).

You will notice a ``count`` variable within this file. We use this to specify
the number of peers per Organization; in our case there are two peers per Org.
We won't delve into the minutiae of `x.509 certificates and public key
infrastructure <https://en.wikipedia.org/wiki/Public_key_infrastructure>`__
right now. If you're interested, you can peruse these topics on your own time.

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

* orderer ``genesis block``,
* fabric ``channel configuration transaction``,
* channel ``channel configuration transaction``,
* and two ``anchor peer transactions`` - one for each Peer Org.

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

Check the logs for the CLI docker container.
Check the logs for the CLI Docker container.

.. code:: bash
Expand Down Expand Up @@ -741,17 +743,17 @@ output from each container:
ex02 Invoke
Query Response:{"Name":"a","Amount":"90"}
Understanding the docker-compose topology
Understanding the Docker Compose topology
-----------------------------------------

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

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

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

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

.. code:: bash
Expand Down Expand Up @@ -910,8 +912,8 @@ Troubleshooting
- **YOU WILL SEE ERRORS IF YOU DO NOT REMOVE CONTAINERS AND IMAGES**

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

.. code:: bash
Expand Down
14 changes: 7 additions & 7 deletions docs/source/capabilities.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Hyperledger Fabric Capabilities

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

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

.. Licensed under Creative Commons Attribution 4.0 International License
https://creativecommons.org/licenses/by/4.0/
6 changes: 3 additions & 3 deletions docs/source/chaincode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ We offer two different perspectives on chaincode. One, from the perspective of
an application developer developing a blockchain application/solution
entitled :doc:`chaincode4ade`, and the other, :doc:`chaincode4noah` oriented
to the blockchain network operator who is responsible for managing a blockchain
network, and who would leverage the Fabric API to install, instantiate, and
upgrade chaincode, but would likely not be involved in the development of a
chaincode application.
network, and who would leverage the Hyperledger Fabric API to install,
instantiate, and upgrade chaincode, but would likely not be involved in the
development of a chaincode application.

.. Licensed under Creative Commons Attribution 4.0 International License
https://creativecommons.org/licenses/by/4.0/
6 changes: 3 additions & 3 deletions docs/source/chaincode4ade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -382,7 +382,7 @@ We start "dev mode" by leveraging pre-generated orderer and channel artifacts fo
a sample dev network. As such, the user can immediately jump into the process
of compiling chaincode and driving calls.

Install Fabric Samples
Install Hyperledger Fabric Samples
----------------------

If you haven't already done so, please install the :doc:`samples`.
Expand All @@ -394,10 +394,10 @@ clone:
cd chaincode-docker-devmode
Download docker images
Download Docker images
----------------------

We need four docker images in order for "dev mode" to run against the supplied
We need four Docker images in order for "dev mode" to run against the supplied
docker compose script. If you installed the ``fabric-samples`` repo clone and
followed the instructions to :ref:`download-platform-specific-binaries`, then
you should have the necessary Docker images installed locally.
Expand Down
11 changes: 6 additions & 5 deletions docs/source/chaincode4noah.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ The Hyperledger Fabric API enables interaction with the various nodes
in a blockchain network - the peers, orderers and MSPs - and it also allows
one to package, install, instantiate and upgrade chaincode on the endorsing
peer nodes. The Hyperledger Fabric language-specific SDKs
abstract the specifics of the Hyperledger Fabric's API to facilitate
abstract the specifics of the Hyperledger Fabric API to facilitate
application development, though it can be used to manage a chaincode's
lifecycle. Additionally, the Hyperledger Fabric's API can be accessed
lifecycle. Additionally, the Hyperledger Fabric API can be accessed
directly via the CLI, which we will use in this document.

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

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

.. code:: bash
Expand Down Expand Up @@ -384,8 +384,9 @@ register with a `fixed set of parameters
compiled in and doesn't have endorsement policies or endorsement policy
functionality.

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

The current list of system chaincodes:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/configtxgen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Channel Configuration (configtxgen)
===================================

This document describe the usage for the ``configtxgen`` utility for
manipulating fabric channel configuration.
manipulating Hyperledger Fabric channel configuration.

For now, the tool is primarily focused on generating the genesis block
for bootstrapping the orderer, but it is intended to be enhanced in the
Expand Down
8 changes: 4 additions & 4 deletions docs/source/dev-setup/build.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Building the fabric
-------------------
Building Hyperledger Fabric
---------------------------

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

To build the Fabric:
To build Hyperledger Fabric:

::

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

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

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

0 comments on commit 9a86c1a

Please sign in to comment.