[FAB-8183] Remove old configtxlator doc

The new command doc layout makes the old configtxlator document superfluous. However, there was still some content in the old doc that was useful to preserve, and has not been moved to the command doc. The old configtxlator doc also contained a number of examples, which are being obsoleted by the newer reconfiguring tutorials. Because reconfiguring your network is a different task from simply using configtxgen, this content would not be appropriate to port. Therefore the bulk of it is simply deleted. Change-Id: I1a2bae5f4f89ee647ad7b00082c638f4958f1e44 Signed-off-by: Jason Yellick <jyellick@us.ibm.com> Signed-off-by: David Enyeart <enyeart@us.ibm.com>
hyperledger · Feb 23, 2018 · 98737a8 · 98737a8
1 parent 684233d
commit 98737a8
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 295 deletions.
diff --git a/docs/source/commands/configtxlator.md b/docs/source/commands/configtxlator.md
@@ -1,8 +1,6 @@
 configtxlator
 =============
 
-# peer channel
-
 ## Description
 
 The `configtxlator` command allows users to translate between protobuf and JSON
@@ -137,3 +135,20 @@ perform the same operations through the REST API.
 ```
 curl -X POST -F channel=testchan -F "original=@original_config.pb" -F "updated=@modified_config.pb" "${CONFIGTXLATOR_URL}/configtxlator/compute/update-from-configs" | curl -X POST --data-binary /dev/stdin "${CONFIGTXLATOR_URL}/protolator/encode/common.ConfigUpdate"
 ```
+
+## Additional Notes
+
+The tool name is a portmanteau of *configtx* and *translator* and is intended to
+convey that the tool simply converts between different equivalent data
+representations. It does not generate configuration. It does not submit or
+retrieve configuration. It does not modify configuration itself, it simply
+provides some bijective operations between different views of the configtx
+format.
+
+There is no configuration file `configtxlator` nor any authentication or
+authorization facilities included for the REST server.  Because `configtxlator`
+does not have any access to data, key material, or other information which
+might be considered sensitive, there is no risk to the owner of the server in
+exposing it to other clients.  However, because the data sent by a user to
+the REST server might be confidential, the user should either trust the
+administrator of the server, run a local instance, or operate via the CLI.
diff --git a/docs/source/configtxlator.rst b/docs/source/configtxlator.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -68,7 +68,6 @@ Business:
    best_practices
    msp
    configtx
-   configtxlator
    cc-packaging-and-signing
    endorsement-policies
    error-handling
@@ -83,6 +82,7 @@ Business:
    :caption: Command Reference
 
    commands/configtxgen.md
+   commands/configtxlator.md
 
 .. toctree::
    :maxdepth: 2