From 74345bee6ac26310e2d6683975edb7198a40ea26 Mon Sep 17 00:00:00 2001 From: "Mark S. Lewis" Date: Thu, 19 Dec 2019 11:32:46 +0000 Subject: [PATCH] FABN-1428: Relocate Node SDK documentation Signed-off-by: Mark S. Lewis --- docs/source/CONTRIBUTING.rst | 2 +- docs/source/chaincode4ade.rst | 2 +- docs/source/chaincode4noah.md | 2 +- docs/source/couchdb_tutorial.rst | 4 ++-- docs/source/developapps/application.md | 2 +- docs/source/developapps/connectionoptions.md | 2 +- docs/source/endorsement-policies.rst | 2 +- docs/source/fabric-sdks.rst | 4 ++-- docs/source/getting_started.rst | 2 +- docs/source/peer_event_services.rst | 2 +- docs/source/pluggable_endorsement_and_validation.rst | 2 +- docs/source/private-data-arch.rst | 2 +- docs/source/understand_fabcar_network.rst | 2 +- 13 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/source/CONTRIBUTING.rst b/docs/source/CONTRIBUTING.rst index ab9b74b5d56..e126fd559a8 100644 --- a/docs/source/CONTRIBUTING.rst +++ b/docs/source/CONTRIBUTING.rst @@ -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). diff --git a/docs/source/chaincode4ade.rst b/docs/source/chaincode4ade.rst index 403abd44e75..ebce9e22b4b 100644 --- a/docs/source/chaincode4ade.rst +++ b/docs/source/chaincode4ade.rst @@ -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 `__. For more information, see :doc:`chaincode4noah`. +`How to install and start your chaincode `__. For more information, see :doc:`chaincode4noah`. The other interface in the chaincode "shim" APIs is the ``ChaincodeStubInterface``: diff --git a/docs/source/chaincode4noah.md b/docs/source/chaincode4noah.md index 5dc6c5dfd9b..d47a9e0e8d4 100644 --- a/docs/source/chaincode4noah.md +++ b/docs/source/chaincode4noah.md @@ -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 diff --git a/docs/source/couchdb_tutorial.rst b/docs/source/couchdb_tutorial.rst index a904e93d0e3..5505db59de3 100644 --- a/docs/source/couchdb_tutorial.rst +++ b/docs/source/couchdb_tutorial.rst @@ -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 `__. +as it conforms to this `directory structure `__. During the chaincode installation using the ``client.installChaincode()`` API, -include the attribute (``metadataPath``) in the `installation request `__. +include the attribute (``metadataPath``) in the `installation request `__. The value of the metadataPath is a string representing the absolute path to the directory structure containing the JSON index file(s). diff --git a/docs/source/developapps/application.md b/docs/source/developapps/application.md index 68aaadf11a5..c529eaa6b9d 100644 --- a/docs/source/developapps/application.md +++ b/docs/source/developapps/application.md @@ -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: diff --git a/docs/source/developapps/connectionoptions.md b/docs/source/developapps/connectionoptions.md index 7a8dae1821b..97fe4534fc5 100644 --- a/docs/source/developapps/connectionoptions.md +++ b/docs/source/developapps/connectionoptions.md @@ -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). diff --git a/docs/source/endorsement-policies.rst b/docs/source/endorsement-policies.rst index dde70f654c1..bc8efca0b55 100644 --- a/docs/source/endorsement-policies.rst +++ b/docs/source/endorsement-policies.rst @@ -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 `_ +For an example, visit the `How to install and start your chaincode `_ 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. diff --git a/docs/source/fabric-sdks.rst b/docs/source/fabric-sdks.rst index aad30b88086..b52dd32a89e 100644 --- a/docs/source/fabric-sdks.rst +++ b/docs/source/fabric-sdks.rst @@ -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 `__. - * `Hyperledger Fabric Java SDK documentation `__. + * `Hyperledger Fabric Node SDK documentation `__. + * `Hyperledger Fabric Java SDK documentation `__. .. Licensed under Creative Commons Attribution 4.0 International License https://creativecommons.org/licenses/by/4.0/ diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 7754e1b8cf5..8dddaf355c2 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -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 `__ and `Node.js SDK documentation `__. + * `Node.js SDK `__ and `Node.js SDK documentation `__. * `Java SDK `__ and `Java SDK documentation `__. In addition, there are two more application SDKs that have not yet been officially released diff --git a/docs/source/peer_event_services.rst b/docs/source/peer_event_services.rst index 823a8c2ffc9..5ebb632b101 100644 --- a/docs/source/peer_event_services.rst +++ b/docs/source/peer_event_services.rst @@ -94,7 +94,7 @@ A filtered block contains: SDK event documentation ----------------------- -For further details on using the event services, refer to the `SDK documentation. `_ +For further details on using the event services, refer to the `SDK documentation. `_ .. Licensed under Creative Commons Attribution 4.0 International License https://creativecommons.org/licenses/by/4.0/ diff --git a/docs/source/pluggable_endorsement_and_validation.rst b/docs/source/pluggable_endorsement_and_validation.rst index 1f4ca2e377f..c1be82a53fa 100644 --- a/docs/source/pluggable_endorsement_and_validation.rst +++ b/docs/source/pluggable_endorsement_and_validation.rst @@ -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 `__. +Fabric SDK for Node.js, visit `How to install and start your chaincode `__. For more information, see :doc:`chaincode4noah`. .. note:: Hereafter, custom endorsement or validation logic implementation is diff --git a/docs/source/private-data-arch.rst b/docs/source/private-data-arch.rst index e525cd09a4b..82469f2c50d 100644 --- a/docs/source/private-data-arch.rst +++ b/docs/source/private-data-arch.rst @@ -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 `_. +visit `How to install and start your chaincode `_. To use the `previous lifecycle process `_ to deploy a private data collection, use the ``--collections-config`` flag when `instantiating your chaincode `_. diff --git a/docs/source/understand_fabcar_network.rst b/docs/source/understand_fabcar_network.rst index ef424b3db07..257f469d174 100644 --- a/docs/source/understand_fabcar_network.rst +++ b/docs/source/understand_fabcar_network.rst @@ -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 `__ though +`Hyperledger Fabric Node SDK `__ 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