Skip to content

Commit

Permalink
[FAB-9184] Edit http:// to https:// for make linkcheck
Browse files Browse the repository at this point in the history
Numerous doc files generate "redirect" warnings when running
"make linkcheck" simply warning that http:// is being mapped to
https://, so make those changes just to quiet the output from
that command.

Change-Id: I89d6ea0d8f402fcdaf6a117c9a6dea32cbd4b8f1
Signed-off-by: Robert P. J. Day <[email protected]>
  • Loading branch information
rpjday committed Mar 28, 2018
1 parent 6e13a04 commit eacec5f
Show file tree
Hide file tree
Showing 13 changed files with 31 additions and 31 deletions.
6 changes: 3 additions & 3 deletions docs/source/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ assistance in debugging a problem or working out a fix to an issue, our
help. We hang out on
`Chat <https://chat.hyperledger.org/channel/fabric/>`__, IRC
(#hyperledger on freenode.net) and the `mailing
lists <http://lists.hyperledger.org/>`__. Most of us don't bite :grin:
lists <https://lists.hyperledger.org/>`__. Most of us don't bite :grin:
and will be glad to help. The only silly question is the one you don't
ask. Questions are in fact a great way to help improve the project as
they highlight where our documentation could be clearer.
Expand Down Expand Up @@ -243,7 +243,7 @@ and Google Hangouts™ for screen sharing between developers. Our
development planning and prioritization is done in
`JIRA <https://jira.hyperledger.org>`__, and we take longer running
discussions/decisions to the `mailing
list <http://lists.hyperledger.org/mailman/listinfo/hyperledger-fabric>`__.
list <https://lists.hyperledger.org/mailman/listinfo/hyperledger-fabric>`__.

Maintainers
-----------
Expand Down Expand Up @@ -285,7 +285,7 @@ We have tried to make it as easy as possible to make contributions. This
applies to how we handle the legal aspects of contribution. We use the
same approach—the `Developer's Certificate of Origin 1.1
(DCO) <https://github.com/hyperledger/fabric/blob/master/docs/source/DCO1.1.txt>`__—that the Linux® Kernel
`community <http://elinux.org/Developer_Certificate_Of_Origin>`__ uses
`community <https://elinux.org/Developer_Certificate_Of_Origin>`__ uses
to manage code contributions.

We simply ask that when submitting a patch for review, the developer
Expand Down
4 changes: 2 additions & 2 deletions docs/source/Gerrit/best-practices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The Gerrit server provides a precommit hook to autogenerate the
Change-Id which is one time use.

**Recommended reading:** `How to Write a Git Commit
Message <http://chris.beams.io/posts/git-commit/>`__
Message <https://chris.beams.io/posts/git-commit/>`__

Avoid Pushing Untested Work to a Gerrit Server
----------------------------------------------
Expand Down Expand Up @@ -270,7 +270,7 @@ branch:
After you get reviewers' feedback, there are changes in **c3** and
**c4** that must be fixed. If the fix requires rebasing, rebasing
changes the commit Ids, see the
`rebasing <http://git-scm.com/book/en/v2/Git-Branching-Rebasing>`__
`rebasing <https://git-scm.com/book/en/v2/Git-Branching-Rebasing>`__
section for more information. However, you must keep the same Change-Id
and push the changes again:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/Gerrit/gerrit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ 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>`__
list <https://lists.hyperledger.org/mailman/listinfo/hyperledger-fabric>`__
and of course, you can reach out on
`chat <https://chat.hyperledger.org/>`__ if you need help.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/Style-guides/go-style.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Coding Golang
~~~~~~~~~~~~~~

We code in Go™ and strictly follow the `best
practices <http://golang.org/doc/effective_go.html>`__ and will not
practices <https://golang.org/doc/effective_go.html>`__ and will not
accept any deviations. You must run the following tools against your Go
code and fix all errors and warnings: -
`golint <https://github.com/golang/lint>`__ - `go
Expand Down
20 changes: 10 additions & 10 deletions docs/source/chaincode4ade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Chaincode API

Every chaincode program must implement the ``Chaincode interface``:

- `Go <http://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#Chaincode>`__
- `Go <https://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#Chaincode>`__
- `node.js <https://fabric-shim.github.io/ChaincodeInterface.html>`__

whose methods are called in response to received transactions.
Expand All @@ -39,7 +39,7 @@ application state. The ``Invoke`` method is called in response to receiving an

The other interface in the chaincode "shim" APIs is the ``ChaincodeStubInterface``:

- `Go <http://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#ChaincodeStub>`__
- `Go <https://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#ChaincodeStub>`__
- `node.js <https://fabric-shim.github.io/ChaincodeStub.html>`__

which is used to access and modify the ledger, and to make invocations between
Expand Down Expand Up @@ -80,11 +80,11 @@ Housekeeping
^^^^^^^^^^^^

First, let's start with some housekeeping. As with every chaincode, it implements the
`Chaincode interface <http://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#Chaincode>`_
`Chaincode interface <https://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#Chaincode>`_
in particular, ``Init`` and ``Invoke`` functions. So, let's add the go import
statements for the necessary dependencies for our chaincode. We'll import the
chaincode shim package and the
`peer protobuf package <http://godoc.org/github.com/hyperledger/fabric/protos/peer>`_.
`peer protobuf package <https://godoc.org/github.com/hyperledger/fabric/protos/peer>`_.
Next, let's add a struct ``SimpleAsset`` as a receiver for Chaincode shim functions.

.. code:: go
Expand Down Expand Up @@ -120,7 +120,7 @@ Next, we'll implement the ``Init`` function.
no "migration" or nothing to be initialized as part of the upgrade.

Next, we'll retrieve the arguments to the ``Init`` call using the
`ChaincodeStubInterface.GetStringArgs <http://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#ChaincodeStub.GetStringArgs>`_
`ChaincodeStubInterface.GetStringArgs <https://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#ChaincodeStub.GetStringArgs>`_
function and check for validity. In our case, we are expecting a key-value pair.

.. code:: go
Expand All @@ -139,7 +139,7 @@ function and check for validity. In our case, we are expecting a key-value pair.
Next, now that we have established that the call is valid, we'll store the
initial state in the ledger. To do this, we will call
`ChaincodeStubInterface.PutState <http://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#ChaincodeStub.PutState>`_
`ChaincodeStubInterface.PutState <https://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#ChaincodeStub.PutState>`_
with the key and value passed in as the arguments. Assuming all went well,
return a peer.Response object that indicates the initialization was a success.

Expand Down Expand Up @@ -185,7 +185,7 @@ As with the ``Init`` function above, we need to extract the arguments from the
name of the chaincode application function to invoke. In our case, our application
will simply have two functions: ``set`` and ``get``, that allow the value of an
asset to be set or its current state to be retrieved. We first call
`ChaincodeStubInterface.GetFunctionAndParameters <http://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#ChaincodeStub.GetFunctionAndParameters>`_
`ChaincodeStubInterface.GetFunctionAndParameters <https://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#ChaincodeStub.GetFunctionAndParameters>`_
to extract the function name and the parameters to that chaincode application
function.

Expand Down Expand Up @@ -235,8 +235,8 @@ Implementing the Chaincode Application
As noted, our chaincode application implements two functions that can be
invoked via the ``Invoke`` function. Let's implement those functions now.
Note that as we mentioned above, to access the ledger's state, we will leverage
the `ChaincodeStubInterface.PutState <http://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#ChaincodeStub.PutState>`_
and `ChaincodeStubInterface.GetState <http://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#ChaincodeStub.GetState>`_
the `ChaincodeStubInterface.PutState <https://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#ChaincodeStub.PutState>`_
and `ChaincodeStubInterface.GetState <https://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#ChaincodeStub.GetState>`_
functions of the chaincode shim API.

.. code:: go
Expand Down Expand Up @@ -277,7 +277,7 @@ Pulling it All Together
^^^^^^^^^^^^^^^^^^^^^^^

Finally, we need to add the ``main`` function, which will call the
`shim.Start <http://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#Start>`_
`shim.Start <https://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#Start>`_
function. Here's the whole chaincode program source.

.. code:: go
Expand Down
4 changes: 2 additions & 2 deletions docs/source/dev-setup/build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Building on Z
~~~~~~~~~~~~~

To make building on Z easier and faster, `this
script <https://github.com/hyperledger/fabric/tree/master/devenv/setupRHELonZ.sh>`__
script <https://github.com/hyperledger/fabric/blob/master/devenv/setupRHELonZ.sh>`__
is provided (which is similar to the `setup
file <https://github.com/hyperledger/fabric/blob/master/devenv/setup.sh>`__
provided for vagrant). This script has been tested only on RHEL 7.2 and
Expand Down Expand Up @@ -119,7 +119,7 @@ Building on Power Platform
Development and build on Power (ppc64le) systems is done outside of
vagrant as outlined `here <#building-outside-of-vagrant>`__. For ease
of setting up the dev environment on Ubuntu, invoke `this
script <https://github.com/hyperledger/fabric/tree/master/devenv/setupUbuntuOnPPC64le.sh>`__
script <https://github.com/hyperledger/fabric/blob/master/devenv/setupUbuntuOnPPC64le.sh>`__
as root. This script has been validated on Ubuntu 16.04 and assumes
certain things (like, development system has OS repositories in place,
firewall setting etc) and in general can be improvised further.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/dev-setup/devenv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Prerequisites
- (macOS)
`Xcode <https://itunes.apple.com/us/app/xcode/id497799835?mt=12>`__
must be installed
- `Docker <https://www.docker.com/products/overview>`__ - 17.06.2-ce or later
- `Docker <https://www.docker.com/get-docker>`__ - 17.06.2-ce or later
- `Docker Compose <https://docs.docker.com/compose/>`__ - 1.14.0 or later
- `Pip <https://pip.pypa.io/en/stable/installing/>`__
- (macOS) you may need to install gnutar, as macOS comes with bsdtar
Expand Down Expand Up @@ -183,7 +183,7 @@ good, it's just cranking.

**NOTE to Windows 10 Users:** There is a known problem with vagrant on
Windows 10 (see
`mitchellh/vagrant#6754 <https://github.com/mitchellh/vagrant/issues/6754>`__).
`hashicorp/vagrant#6754 <https://github.com/hashicorp/vagrant/issues/6754>`__).
If the ``vagrant up`` command fails it may be because you do not have
the Microsoft Visual C++ Redistributable package installed. You can
download the missing package at the following address:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ API Documentation
^^^^^^^^^^^^^^^^^

The API documentation for Hyperledger Fabric's Golang APIs can be found on
the godoc site for `Fabric <http://godoc.org/github.com/hyperledger/fabric>`_.
the godoc site for `Fabric <https://godoc.org/github.com/hyperledger/fabric>`_.
If you plan on doing any development using these APIs, you may want to
bookmark those links now.

Expand Down
8 changes: 4 additions & 4 deletions docs/source/idemix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ authority(ies) (CA).
| More details on the concepts and features of the Identity Mixer
technology are described in the paper `Concepts and Languages for
Privacy-Preserving Attribute-Based
Authentication <http://link.springer.com/chapter/10.1007%2F978-3-642-37282-7_4>`__.
Authentication <https://link.springer.com/chapter/10.1007%2F978-3-642-37282-7_4>`__.
| More information about the Identity Mixer code, demos, and
publications is available on the `Identity Mixer project home
page <http://www.research.ibm.com/labs/zurich/idemix>`__.
Expand Down Expand Up @@ -182,11 +182,11 @@ All cryptographic building blocks were published at the top conferences and jour

This particular Identity Mixer implementation uses a pairing-based
signature scheme that was briefly proposed by `Camenisch and
Lysyanskaya <http://link.springer.com/chapter/10.1007/978-3-540-28628-8_4>`__
Lysyanskaya <https://link.springer.com/chapter/10.1007/978-3-540-28628-8_4>`__
and described in detail by `Au et
al. <http://link.springer.com/chapter/10.1007/11832072_8>`__. We use the
al. <https://link.springer.com/chapter/10.1007/11832072_8>`__. We use the
zero-knowledge proof by `Camenisch et
al. <http://eprint.iacr.org/2016/663.pdf>`__ to prove knowledge of a
al. <https://eprint.iacr.org/2016/663.pdf>`__ to prove knowledge of a
signature. Please refer to the papers for the algorithms details and
security proofs.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/kafka.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Then proceed as follows:

If any of these steps fail, you can adjust the frequency with which they are repeated. Specifically they will be re-attempted every ``Kafka.Retry.ShortInterval`` for a total of ``Kafka.Retry.ShortTotal``, and then every ``Kafka.Retry.LongInterval`` for a total of ``Kafka.Retry.LongTotal`` until they succeed. Note that the orderer will be unable to write to or read from a channel until all of the steps above have been completed successfully.

#. **Set up the OSNs and Kafka cluster so that they communicate over SSL.** (Optional step, but highly recommended.) Refer to `the Confluent guide <http://docs.confluent.io/2.0.0/kafka/ssl.html>`_ for the Kafka cluster side of the equation, and set the keys under ``Kafka.TLS`` in ``orderer.yaml`` on every OSN accordingly.
#. **Set up the OSNs and Kafka cluster so that they communicate over SSL.** (Optional step, but highly recommended.) Refer to `the Confluent guide <https://docs.confluent.io/2.0.0/kafka/ssl.html>`_ for the Kafka cluster side of the equation, and set the keys under ``Kafka.TLS`` in ``orderer.yaml`` on every OSN accordingly.
#. **Bring up the nodes in the following order: ZooKeeper ensemble, Kafka cluster, ordering service nodes.**

Additional considerations
Expand Down
2 changes: 1 addition & 1 deletion docs/source/prereqs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Docker and Docker Compose
You will need the following installed on the platform on which you will be
operating, or developing on (or for), Hyperledger Fabric:

- MacOSX, \*nix, or Windows 10: `Docker <https://www.docker.com/products/overview>`__
- MacOSX, \*nix, or Windows 10: `Docker <https://www.docker.com/get-docker>`__
Docker version 17.06.2-ce or greater is required.
- Older versions of Windows: `Docker
Toolbox <https://docs.docker.com/toolbox/toolbox_install_windows/>`__ -
Expand Down
4 changes: 2 additions & 2 deletions docs/source/questions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ We try to maintain a comprehensive set of documentation for various
audiences. However, we realize that often there are questions that
remain unanswered. For any technical questions relating to Hyperledger
Fabric not answered here, please use
`StackOverflow <http://stackoverflow.com/questions/tagged/hyperledger-fabric>`__.
`StackOverflow <https://stackoverflow.com/questions/tagged/hyperledger-fabric>`__.
Another approach to getting your questions answered to send an email to
the `mailing
list <http://lists.hyperledger.org/mailman/listinfo/hyperledger-fabric>`__
list <https://lists.hyperledger.org/mailman/listinfo/hyperledger-fabric>`__
([email protected]), or ask your questions on
`RocketChat <https://chat.hyperledger.org/>`__ (an alternative to Slack)
on the #fabric or #fabric-questions channel.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/systemchaincode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ using the Go `plugin <https://golang.org/pkg/plugin>`_ package.
A plugin includes a main package with exported symbols and is built with the command
``go build -buildmode=plugin``.

Every system chaincode must implement the `Chaincode Interface <http://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#Chaincode>`_
Every system chaincode must implement the `Chaincode Interface <https://godoc.org/github.com/hyperledger/fabric/core/chaincode/shim#Chaincode>`_
and export a constructor method that matches the signature ``func New() shim.Chaincode`` in the main package.
An example can be found in the repository at ``examples/plugin/scc``.

Expand Down

0 comments on commit eacec5f

Please sign in to comment.