Document deprecation as of Fabric v2.5 (#668)

Signed-off-by: Mark S. Lewis <[email protected]>

Author: bestbeforetoday

README.md

@@ -1,6 +1,6 @@
 ## Hyperledger Fabric Client SDK for Node.js <a href="https://github.com/hyperledger/fabric-sdk-node/actions/workflows/scheduled.yml"><img src="https://github.com/hyperledger/fabric-sdk-node/actions/workflows/scheduled.yml/badge.svg" alt="Build status" style="float: right"></a>
 
-> **Note:** When developing applications for Hyperledger Fabric v2.4 and later, you should use the [Fabric Gateway client API](https://hyperledger.github.io/fabric-gateway/).
+> **Note:** This API is deprecated as of Fabric v2.5. When developing applications for Hyperledger Fabric v2.4 and later, you should use the [Fabric Gateway client API](https://hyperledger.github.io/fabric-gateway/).
 
 The Hyperledger Fabric Client SDK makes it possible to use APIs to interact with a Hyperledger Fabric blockchain. This readme is directed towards a current or future contributor to this project, and gives an overview of setting up the project locally and running tests. For more information on the SDK, including features and an API reference, please visit the [SDK documentation](https://hyperledger.github.io/fabric-sdk-node/).
 

docs/index.md

@@ -1,6 +1,8 @@
 
 The Hyperledger Fabric SDK for Node.js provides a powerful API to interact with a Hyperledger Fabric blockchain. The SDK is designed to be used in the Node.js JavaScript runtime.
 
+> **Note:** This API is deprecated as of Fabric v2.5, replaced by the [Fabric Gateway client API](https://hyperledger.github.io/fabric-gateway/).
+
 
 ### Overview
 

fabric-ca-client/README.md

@@ -1,9 +1,9 @@
 ## Hyperledger Fabric-CA Client for Node.js
 
-[![NPM](https://nodei.co/npm/fabric-ca-client.svg?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/fabric-ca-client/)
-
 SDK for writing node.js applications to interact with [Hyperledger Fabric CA](http://hyperledger-fabric-ca.readthedocs.io/en/latest/users-guide.html).
 
+> **Note:** This API is deprecated as of Fabric v2.5. When developing applications for Hyperledger Fabric v2.4 and later, you should use the [Fabric Gateway client API](https://hyperledger.github.io/fabric-gateway/).
+
 This package encapsulates the APIs to interact with the Fabric CA to manage user certificates lifecycle such as register, enroll, renew and revoke.
 
 Additional packages are also provided:

fabric-ca-client/index.js

@@ -10,6 +10,8 @@
  * This is the main module for the "fabric-ca-client" package. It communicates with the
  * "fabric-ca" server to manage user certificates lifecycle including register, enroll,
  * renew and revoke, so that the application can use the properly signed certificates to
- * authenticate with the fabric
+ * authenticate with the fabric.
+ *
+ * @deprecated As of Fabric v2.5.
  */
 module.exports = require('./lib/FabricCAServices.js');

fabric-common/README.md

@@ -2,6 +2,8 @@
 
 SDK for writing node.js applications to interact with [Hyperledger Fabric](http://hyperledger-fabric.readthedocs.io/en/latest/).
 
+> **Note:** This API is deprecated as of Fabric v2.5. When developing applications for Hyperledger Fabric v2.4 and later, you should use the [Fabric Gateway client API](https://hyperledger.github.io/fabric-gateway/).
+
 This package encapsulates the common code used by the `fabric-ca-client`, `fabric-network` packages. Additional packages are also provided:
 1. `fabric-ca-client`, to interact with the fabric-ca to manage user certificates.
 2. `fabric-network`, to provide APIs to connect to a Fabric network, submit transactions and perform queries against the ledger.

fabric-network/README.md

@@ -2,7 +2,7 @@
 
 SDK for writing node.js applications to interact with [Hyperledger Fabric](http://hyperledger-fabric.readthedocs.io/en/latest/).
 
-> **Note:** When developing applications for Hyperledger Fabric v2.4 and later, you are strongly encouraged to use the [Fabric Gateway client API](https://hyperledger.github.io/fabric-gateway/).
+> **Note:** This API is deprecated as of Fabric v2.5. When developing applications for Hyperledger Fabric v2.4 and later, you should use the [Fabric Gateway client API](https://hyperledger.github.io/fabric-gateway/).
 
 This package encapsulates the APIs to connect to a Fabric network, submit transactions and perform queries against the ledger, and listen for or replay events.
 

fabric-network/index.js

@@ -5,6 +5,10 @@
  */
 
 /**
+ * <blockquote>
+ * <p><strong>Note:</strong> This API is deprecated as of Fabric v2.5, replaced by the <a href="https://hyperledger.github.io/fabric-gateway/">Fabric Gateway client API</a>.</p>
+ * </blockquote>
+ *
  * <h3>Overview</h3>
  *
  * <p>This module provides a higher level API for interacting with smart contracts, and is the recommended API for
@@ -73,6 +77,7 @@
  * }
  *
  * @module fabric-network
+ * @deprecated As of Fabric v2.5, replaced by the <a href="https://hyperledger.github.io/fabric-gateway/">Fabric Gateway client API</a>.
  */
 
 /**

fabric-protos/README.md

@@ -2,6 +2,8 @@
 
 SDK for writing node.js applications to interact with [Hyperledger Fabric](http://hyperledger-fabric.readthedocs.io/en/latest/).
 
+> **Note:** This API is deprecated as of Fabric v2.5. When developing applications for Hyperledger Fabric v2.4 and later, you should use the [Fabric Gateway client API](https://hyperledger.github.io/fabric-gateway/).
+
 This package encapsulates the Protocol Buffer files and generated JavaScript classes for Hyperledger Fabric.
 
 Additional packages are also provided: