From 093985ab92d596879a81c1898acf503d6fbeaed1 Mon Sep 17 00:00:00 2001 From: Gari Singh <gari.r.singh@gmail.com> Date: Wed, 5 Jul 2017 16:08:54 -0400 Subject: [PATCH] FAB-5189 Hyperledger Project should be Hyperledger Changes any reference to Hyperledger Project to just Hyperledger. Also fixes / corrects the use of project in conjunction with Hyperledger Fabric to make things more clear Change-Id: I3bb8a1c77a2a47c4a885586fe2108e4be8337244 Signed-off-by: Gari Singh <gari.r.singh@gmail.com> --- docs/source/CONTRIBUTING.rst | 7 +++---- docs/source/Gerrit/gerrit.rst | 8 ++++---- docs/source/Style-guides/go-style.rst | 2 +- docs/source/dev-setup/devenv.rst | 6 +++--- docs/source/status.rst | 4 ++-- docs/source/whyfabric.rst | 2 +- 6 files changed, 14 insertions(+), 15 deletions(-) diff --git a/docs/source/CONTRIBUTING.rst b/docs/source/CONTRIBUTING.rst index a2c745f46dd..d583469258c 100644 --- a/docs/source/CONTRIBUTING.rst +++ b/docs/source/CONTRIBUTING.rst @@ -1,10 +1,10 @@ Contributions Welcome! ====================== -We welcome contributions to the Hyperledger Project in many forms, and +We welcome contributions to Hyperledger in many forms, and there's always plenty to do! -First things first, please review the Hyperledger Project's `Code of +First things first, please review the Hyperledger `Code of Conduct <https://wiki.hyperledger.org/community/hyperledger-project-code-of-conduct>`__ before participating. It is important that we keep things civil. @@ -235,8 +235,7 @@ Maintainers The project's :doc:`maintainers <MAINTAINERS>` are responsible for reviewing and merging all patches submitted for review and they guide the over-all technical direction of the project within the guidelines -established by the Hyperledger Project's Technical Steering Committee -(TSC). +established by the Hyperledger Technical Steering Committee (TSC). Becoming a maintainer ~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/Gerrit/gerrit.rst b/docs/source/Gerrit/gerrit.rst index f97f18daceb..f8fb48d7929 100644 --- a/docs/source/Gerrit/gerrit.rst +++ b/docs/source/Gerrit/gerrit.rst @@ -1,8 +1,8 @@ Working with Gerrit =================== -Follow these instructions to collaborate on the Hyperledger Fabric -Project through the Gerrit review system. +Follow these instructions to collaborate on Hyperledger Fabric +through the Gerrit review system. Please be sure that you are subscribed to the `mailing list <http://lists.hyperledger.org/mailman/listinfo/hyperledger-fabric>`__ @@ -138,7 +138,7 @@ be pushed to a special branch. The name of this special branch contains a reference to the final branch where the code should reside, once accepted. -For the Hyperledger Fabric Project, the special branch is called +For the Hyperledger Fabric repository, the special branch is called ``refs/for/master``. To push the current local development branch to the gerrit server, open @@ -239,7 +239,7 @@ If you collaborate in multiple projects, you may wish to limit searching to the specific branch through the search bar in the upper-right side. Add the filter *project:fabric* to limit the visible changes to only -those from the Hyperledger Fabric Project. +those from Hyperledger Fabric. List all current changes you submitted, or list just those changes in need of your input by clicking on ``My --> Changes`` or `open this diff --git a/docs/source/Style-guides/go-style.rst b/docs/source/Style-guides/go-style.rst index 1d8854b887b..b80d6aec6e8 100644 --- a/docs/source/Style-guides/go-style.rst +++ b/docs/source/Style-guides/go-style.rst @@ -26,7 +26,7 @@ generate/update the respective ``.pb.go`` files. Adding or updating Go packages ------------------------------ -The Hyperledger Fabric Project uses Govendor for package +Hyperledger Fabric uses Govendor for package management. This means that all required packages reside in the ``$GOPATH/src/github.com/hyperledger/fabric/vendor`` folder. Go will use packages in this folder instead of the GOPATH when the ``go install`` or diff --git a/docs/source/dev-setup/devenv.rst b/docs/source/dev-setup/devenv.rst index 9efccbcb813..1ac615da408 100644 --- a/docs/source/dev-setup/devenv.rst +++ b/docs/source/dev-setup/devenv.rst @@ -97,10 +97,10 @@ If you continue with ``core.autocrlf`` set to ``true``, the ``./setup.sh: /bin/bash^M: bad interpreter: No such file or directory`` -Cloning the Hyperledger Fabric project +Cloning the Hyperledger Fabric source ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Since the Hyperledger Fabric project is a ``Go`` project, you'll need to +Since Hyperledger Fabric is written in ``Go``, you'll need to clone the source repository to your $GOPATH/src directory. If your $GOPATH has multiple path components, then you will want to use the first one. There's a little bit of setup needed: @@ -143,7 +143,7 @@ be able to ``ssh`` into the Vagrant VM just created. vagrant ssh -Once inside the VM, you can find the peer project under +Once inside the VM, you can find the source under ``$GOPATH/src/github.com/hyperledger/fabric``. It is also mounted as ``/hyperledger``. diff --git a/docs/source/status.rst b/docs/source/status.rst index 74fc31e92c0..fb1fd15c99e 100644 --- a/docs/source/status.rst +++ b/docs/source/status.rst @@ -1,8 +1,8 @@ Status ================= -This project is an *Active* Hyperledger project. For more information on the history of this project see our `wiki page <https://wiki.hyperledger.org/projects/fabric#history>`__. Information on what *Active* entails can be found in -the `Hyperledger Project Lifecycle document <https://wiki.hyperledger.org/community/project-lifecycle>`__. +Hyperledger Fabric is in the *Active* state. For more information on the history of this project see our `wiki page <https://wiki.hyperledger.org/projects/fabric#history>`__. Information on what *Active* entails can be found in +the Hyperledger `Project Lifecycle document <https://wiki.hyperledger.org/community/project-lifecycle>`__. .. Licensed under Creative Commons Attribution 4.0 International License https://creativecommons.org/licenses/by/4.0/ diff --git a/docs/source/whyfabric.rst b/docs/source/whyfabric.rst index 3291854ab59..3df47664f53 100644 --- a/docs/source/whyfabric.rst +++ b/docs/source/whyfabric.rst @@ -1,7 +1,7 @@ Why Hyperledger Fabric? ======================= -The Hyperledger Fabric project is delivering a blockchain platform +Hyperledger Fabric is delivering a blockchain platform designed to allow the exchange of an asset or the state of an asset to be consented upon, maintained, and viewed by all parties in a permissioned group. A key characteristic of Hyperledger Fabric is that