Skip to content

Commit

Permalink
[FAB-9969] blockchain.rst: Fix wording and em dashes
Browse files Browse the repository at this point in the history
Reword one paragraph for clarity and, while we're here, make all
of the "em" dash rendering consistent by using the recommended
"---" code that works for both .rst and Markdown, rather than
bouncing between two other (both incorrect) encodings.

Change-Id: I50e5b81af414125d87ecb6bae831edb6c4ebdfcf
Signed-off-by: Robert P. J. Day <[email protected]>
  • Loading branch information
rpjday committed May 9, 2018
1 parent 7e98df2 commit 25fabb8
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions docs/source/blockchain.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ We recommend first-time users begin by going through the rest of the
introduction below in order to gain familiarity with how blockchains work
and with the specific features and components of Hyperledger Fabric.

Once comfortable -- or if you're already familiar with blockchain and
Hyperledger Fabric -- go to :doc:`getting_started` and from there explore the
Once comfortable --- or if you're already familiar with blockchain and
Hyperledger Fabric --- go to :doc:`getting_started` and from there explore the
demos, technical specifications, APIs, etc.

What is a Blockchain?
Expand All @@ -37,8 +37,8 @@ after the fact. It’s why blockchains are sometimes described as **systems of p

**Smart Contracts**

To support the consistent update of information - and to enable a whole host of
ledger functions (transacting, querying, etc) - a blockchain network uses **smart
To support the consistent update of information --- and to enable a whole host of
ledger functions (transacting, querying, etc) --- a blockchain network uses **smart
contracts** to provide controlled access to the ledger.

.. image:: images/Smart_Contract.png
Expand All @@ -48,16 +48,16 @@ and keeping it simple across the network, they can also be written to allow
participants to execute certain aspects of transactions automatically.

A smart contract can, for example, be written to stipulate the cost of shipping
an item that changes depending on when it arrives. With the terms agreed to
by both parties and written to the ledger, the appropriate funds change hands
automatically when the item is received.
an item where the shipping charge changes depending on how quickly the item arrives.
With the terms agreed to by both parties and written to the ledger,
the appropriate funds change hands automatically when the item is received.

**Consensus**

The process of keeping the ledger transactions synchronized across the network -
The process of keeping the ledger transactions synchronized across the network ---
to ensure that ledgers update only when transactions are approved by the appropriate
participants, and that when ledgers do update, they update with the
same transactions in the same order - is called **consensus**.
same transactions in the same order --- is called **consensus**.

.. image:: images/consensus.png

Expand All @@ -74,9 +74,9 @@ Why is a Blockchain useful?
The transactional networks of today are little more than slightly updated
versions of networks that have existed since business records have been kept.
The members of a **business network** transact with each other, but they maintain
separate records of their transactions. And the things they’re transacting -
separate records of their transactions. And the things they’re transacting ---
whether it’s Flemish tapestries in the 16th century or the securities of today
- must have their provenance established each time they’re sold to ensure that
--- must have their provenance established each time they’re sold to ensure that
the business selling an item possesses a chain of title verifying their
ownership of it.

Expand Down Expand Up @@ -127,7 +127,7 @@ the sharing of information and processes.
What is Hyperledger Fabric?
---------------------------

The Linux Foundation founded Hyperledger in 2015 to advance
The Linux Foundation founded the Hyperledger project in 2015 to advance
cross-industry blockchain technologies. Rather than declaring a single
blockchain standard, it encourages a collaborative approach to developing
blockchain technologies via a community process, with intellectual property
Expand All @@ -151,9 +151,9 @@ 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
important option for networks where some participants might be competitors and not
want every transaction they make - a special price they're offering to some participants
and not others, for example -- known to every participant. If two participants
form a channel, then those participants and no others have copies of the ledger
want every transaction they make --- a special price they're offering to some participants
and not others, for example --- known to every participant. If two participants
form a channel, then those participants --- and no others --- have copies of the ledger
for that channel.

**Shared Ledger**
Expand Down Expand Up @@ -233,7 +233,7 @@ identities into roles in a Fabric network.

* `Peers <peers/peers.html>`_ (conceptual documentation)

Peers -- owned by organizations -- host the ledger and smart contracts and make
Peers --- owned by organizations --- host the ledger and smart contracts and make
up the physical structure of a Fabric network.

* :doc:`build_network` (tutorial)
Expand All @@ -244,7 +244,7 @@ step at a time.

* :doc:`write_first_app` (tutorial)

Deploys a very simple network -- even simpler than Build Your First Network --
Deploys a very simple network --- even simpler than Build Your First Network ---
to use with a simple smart contract and application.

* :doc:`txflow`
Expand Down

0 comments on commit 25fabb8

Please sign in to comment.