Skip to content

Commit

Permalink
FABN-1428: Relocate Node SDK documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Mark S. Lewis <mark_lewis@uk.ibm.com>
  • Loading branch information
bestbeforetoday authored and mastersingh24 committed Dec 24, 2019
1 parent f20eeb4 commit 74345be
Show file tree
Hide file tree
Showing 13 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/source/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ hours (3 days), it will be flagged to the #fabric-pr-review channel daily until
it receives a review comment(s).

This policy applies to all official Fabric projects (fabric, fabric-ca,
fabric-samples, fabric-test, fabric-sdk-node, fabric-sdk-java,
fabric-samples, fabric-test, fabric-sdk-node, fabric-sdk-java, fabric-gateway-java,
fabric-chaincode-node, fabric-chaincode-java, fabric-chaincode-evm,
fabric-baseimage, and fabric-amcl).

Expand Down
2 changes: 1 addition & 1 deletion docs/source/chaincode4ade.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ the peer CLI to approve the chaincode definition, use the ``--init-required``
flag to request the execution of the ``Init`` function. Then call the ``Init``
function by using the `peer chaincode invoke` command and passing the
``--isInit`` flag. If you are using the Fabric SDK for Node.js, visit
`How to install and start your chaincode <https://fabric-sdk-node.github.io/master/tutorial-chaincode-lifecycle.html>`__. For more information, see :doc:`chaincode4noah`.
`How to install and start your chaincode <https://hyperledger.github.io/fabric-sdk-node/master/tutorial-chaincode-lifecycle.html>`__. For more information, see :doc:`chaincode4noah`.

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

Expand Down
2 changes: 1 addition & 1 deletion docs/source/chaincode4noah.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ chaincode lifecycle rather than the specific commands. To learn more about how
to use the Fabric lifecycle using the Peer CLI, see [Install and define a chaincode](build_network.html#install-define-chaincode)
in the Building your First Network Tutorial or the [peer lifecycle command reference](commands/peerlifecycle.html).
To learn more about how to use the Fabric lifecycle using the Fabric SDK for
Node.js, visit [How to install and start your chaincode](https://fabric-sdk-node.github.io/master/tutorial-chaincode-lifecycle.html).
Node.js, visit [How to install and start your chaincode](https://hyperledger.github.io/fabric-sdk-node/master/tutorial-chaincode-lifecycle.html).

### Step One: Packaging the smart contract

Expand Down
4 changes: 2 additions & 2 deletions docs/source/couchdb_tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -251,9 +251,9 @@ deployment by being placed alongside it in the appropriate metadata folder.

If your chaincode installation and instantiation uses the Hyperledger
Fabric Node SDK, the JSON index files can be located in any folder as long
as it conforms to this `directory structure <https://fabric-sdk-node.github.io/tutorial-metadata-chaincode.html>`__.
as it conforms to this `directory structure <https://hyperledger.github.io/fabric-sdk-node/master/tutorial-metadata-chaincode.html>`__.
During the chaincode installation using the ``client.installChaincode()`` API,
include the attribute (``metadataPath``) in the `installation request <https://fabric-sdk-node.github.io/global.html#ChaincodeInstallRequest>`__.
include the attribute (``metadataPath``) in the `installation request <https://hyperledger.github.io/fabric-sdk-node/master/global.html#ChaincodeInstallRequest>`__.
The value of the metadataPath is a string representing the absolute path to the
directory structure containing the JSON index file(s).

Expand Down
2 changes: 1 addition & 1 deletion docs/source/developapps/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ const { FileSystemWallet, Gateway } = require('fabric-network');
```

You can read about the `fabric-network` classes in the
[node SDK documentation](https://fabric-sdk-node.github.io/master/module-fabric-network.html), but for
[node SDK documentation](https://hyperledger.github.io/fabric-sdk-node/master/module-fabric-network.html), but for
now, let's see how they are used to connect MagnetoCorp's application to
PaperNet. The application uses the Fabric **Wallet** class as follows:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/developapps/connectionoptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Here's a list of the available options and what they do.

* <`PluginEventHandlerFunction`> The name of a user-defined event handler.
This allows a user to define their own logic for event handling. See how to
[define](https://fabric-sdk-node.github.io/master/tutorial-transaction-commit-events.html)
[define](https://hyperledger.github.io/fabric-sdk-node/master/tutorial-transaction-commit-events.html)
a plugin event handler, and examine a [sample
handler](https://github.com/hyperledger/fabric-sdk-node/blob/master/test/integration/network-e2e/sample-transaction-event-handler.js).

Expand Down
2 changes: 1 addition & 1 deletion docs/source/endorsement-policies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Any invoke of the chaincode that writes data to the ledger will need to be
validated by enough channel members to meet the endorsement policy.

You can specify an endorsement policy for a chainocode using the Fabric SDKs.
For an example, visit the `How to install and start your chaincode <https://fabric-sdk-node.github.io/master/tutorial-chaincode-lifecycle.html>`_
For an example, visit the `How to install and start your chaincode <https://hyperledger.github.io/fabric-sdk-node/master/tutorial-chaincode-lifecycle.html>`_
in the Node.js SDK documentation. You can also create an endorsement policy from
your CLI when you approve and commit a chaincode definition with the Fabric peer
binaries by using the ``—-signature-policy`` flag.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/fabric-sdks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Hyperledger Fabric intends to offer a number of SDKs for a wide variety of
programming languages. The first two delivered are the Node.js and Java
SDKs. We hope to provide Python, REST and Go SDKs in a subsequent release.

* `Hyperledger Fabric Node SDK documentation <https://fabric-sdk-node.github.io/>`__.
* `Hyperledger Fabric Java SDK documentation <https://github.com/hyperledger/fabric-sdk-java>`__.
* `Hyperledger Fabric Node SDK documentation <https://hyperledger.github.io/fabric-sdk-node/>`__.
* `Hyperledger Fabric Java SDK documentation <https://hyperledger.github.io/fabric-gateway-java/>`__.

.. Licensed under Creative Commons Attribution 4.0 International License
https://creativecommons.org/licenses/by/4.0/
2 changes: 1 addition & 1 deletion docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Hyperledger Fabric application SDKs
Hyperledger Fabric offers a number of SDKs to support developing applications
in various programming languages. SDKs are available for Node.js and Java:

* `Node.js SDK <https://github.com/hyperledger/fabric-sdk-node>`__ and `Node.js SDK documentation <https://fabric-sdk-node.github.io/>`__.
* `Node.js SDK <https://github.com/hyperledger/fabric-sdk-node>`__ and `Node.js SDK documentation <https://hyperledger.github.io/fabric-sdk-node/>`__.
* `Java SDK <https://github.com/hyperledger/fabric-gateway-java>`__ and `Java SDK documentation <https://hyperledger.github.io/fabric-gateway-java/>`__.

In addition, there are two more application SDKs that have not yet been officially released
Expand Down
2 changes: 1 addition & 1 deletion docs/source/peer_event_services.rst
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ A filtered block contains:
SDK event documentation
-----------------------

For further details on using the event services, refer to the `SDK documentation. <https://fabric-sdk-node.github.io/tutorial-channel-events.html>`_
For further details on using the event services, refer to the `SDK documentation. <https://hyperledger.github.io/fabric-sdk-node/master/tutorial-channel-events.html>`_

.. Licensed under Creative Commons Attribution 4.0 International License
https://creativecommons.org/licenses/by/4.0/
2 changes: 1 addition & 1 deletion docs/source/pluggable_endorsement_and_validation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ The name of the custom plugin needs to be referenced by the chaincode definition
to be used by the chaincode. If you are using the peer CLI to approve the
chaincode definition, use the ``--escc`` and ``--vscc`` flag to select the name
of the custom endorsement or validation library. If you are using the
Fabric SDK for Node.js, visit `How to install and start your chaincode <https://fabric-sdk-node.github.io/master/tutorial-chaincode-lifecycle.html>`__.
Fabric SDK for Node.js, visit `How to install and start your chaincode <https://hyperledger.github.io/fabric-sdk-node/master/tutorial-chaincode-lifecycle.html>`__.
For more information, see :doc:`chaincode4noah`.

.. note:: Hereafter, custom endorsement or validation logic implementation is
Expand Down
2 changes: 1 addition & 1 deletion docs/source/private-data-arch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ is committed to the channel. The collection file needs to be the same for all
channel members. If you are using the peer CLI to approve and commit the
chaincode definition, use the ``--collections-config`` flag to specify the path
to the collection definition file. If you are using the Fabric SDK for Node.js,
visit `How to install and start your chaincode <https://fabric-sdk-node.github.io/master/tutorial-chaincode-lifecycle.html>`_.
visit `How to install and start your chaincode <https://hyperledger.github.io/fabric-sdk-node/master/tutorial-chaincode-lifecycle.html>`_.
To use the `previous lifecycle process <https://hyperledger-fabric.readthedocs.io/en/release-1.4/chaincode4noah.html>`_ to deploy a private data collection,
use the ``--collections-config`` flag when `instantiating your chaincode <https://hyperledger-fabric.readthedocs.io/en/latest/commands/peerchaincode.html#peer-chaincode-instantiate>`_.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/understand_fabcar_network.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ where the name is ``fabcar``, the version is ``1.0``, and the peer it is running
against is ``dev-peer0.org1.example.com``.

APIs are accessible with an SDK. For purposes of this exercise, we're using the
`Hyperledger Fabric Node SDK <https://fabric-sdk-node.github.io/>`__ though
`Hyperledger Fabric Node SDK <https://hyperledger.github.io/fabric-sdk-node/>`__ though
there is also a Java SDK and CLI that can be used to drive transactions.
SDKs encapsulate all access to the ledger by allowing an application to
communicate with smart contracts, run queries, or receive ledger updates. These APIs use
Expand Down

0 comments on commit 74345be

Please sign in to comment.