From c6cec0aa3d871c2557122da6910887daeb1a78ec Mon Sep 17 00:00:00 2001 From: Patrick Kuo Date: Wed, 23 Nov 2016 09:57:28 +0000 Subject: [PATCH] address PR comments --- docs/source/node-explorer.rst | 14 ++++++++------ tools/explorer/README.md | 22 +++++++++++----------- 2 files changed, 19 insertions(+), 17 deletions(-) diff --git a/docs/source/node-explorer.rst b/docs/source/node-explorer.rst index 4500a756c3..b9152c9d6a 100644 --- a/docs/source/node-explorer.rst +++ b/docs/source/node-explorer.rst @@ -34,9 +34,9 @@ Running Demo Nodes Interface --------- Login - User can login to any Corda node using the explorer, alternately, ``gradlew explorer:runDemoNodes`` can be used to start up demo nodes for testing. + User can login to any Corda node using the explorer. Alternatively, ``gradlew explorer:runDemoNodes`` can be used to start up demo nodes for testing. Corda node address, username and password are required for login, the address is defaulted to localhost:0 if leave blank. - Username and password can be configured via ``rpcUsers`` field in node's configuration file; for demo nodes, it is defaulted to ``user1`` and ``test``. + Username and password can be configured via the ``rpcUsers`` field in node's configuration file; for demo nodes, it is defaulted to ``user1`` and ``test``. .. note:: If you are connecting to the demo nodes, only Alice and Bob (20004, 20006) are accessible using user1 credential, you won't be able to connect to the notary. @@ -45,7 +45,8 @@ Login :align: center Dashboard - The dashboard shows the top level state of node and vault; currently, it shows your cash balance and the numbers of transaction executed. + The dashboard shows the top level state of node and vault. + Currently, it shows your cash balance and the numbers of transaction executed. The dashboard is intended to house widgets from different CordApp's and provide useful information to system admin at a glance. .. image:: resources/explorer/dashboard.png @@ -57,7 +58,7 @@ Cash .. image:: resources/explorer/vault.png New cash transaction - This is where you can create new cash transaction. + This is where you can create new cash transactions. The user can choose from three transaction types (issue, pay and exit) and any party visible on the network. The result of the transaction will be visible in the transaction screen when executed. @@ -71,7 +72,8 @@ Transactions .. image:: resources/explorer/transactionView.png Network - The network view shows the network information on the world map. Currently only user's node is rendered on the map, this will be extended to other peers in future release. + The network view shows the network information on the world map. Currently only the user's node is rendered on the map. + This will be extended to other peers in a future release. The map provides a intuitive way of visualizing the Corda network and the participants. .. image:: resources/explorer/network.png @@ -79,7 +81,7 @@ Network Settings User can configure the client preference in this view. -.. note:: Although the reporting currency is configurable, FX conversion won't be applied to the values as we don't have a FX service yet. +.. note:: Although the reporting currency is configurable, FX conversion won't be applied to the values as we don't have an FX service yet. .. image:: resources/explorer/settings.png diff --git a/tools/explorer/README.md b/tools/explorer/README.md index e87c9f61e8..922e30024f 100644 --- a/tools/explorer/README.md +++ b/tools/explorer/README.md @@ -1,30 +1,30 @@ -#Node Explorer +# Node Explorer -The node explorer provide views to the node's vault and transaction data using Corda's RPC framework. -The user can execute cash transaction commands to issue and move cash to other party on the network or exit cash using the user interface. +The node explorer provide views of the node's vault and transaction data using Corda's RPC framework. +The user can execute cash transaction commands to issue and move cash to other parties on the network or exit cash using the user interface. -##Running the UI +## Running the UI -#####Windows: +**Windows:** gradlew.bat tools:explorer:run -#####Other: +**Other:** ./gradlew tools:explorer:run -##Running Demo Nodes +## Running Demo Nodes -#####Windows: +**Windows:** gradlew.bat tools:explorer:runDemoNodes -#####Other: +**Other:** ./gradlew tools:explorer:runDemoNodes -#####These Corda nodes will be created on the following port on localhost. +**These Corda nodes will be created on the following port on localhost.** Notary -> 20002 Alice -> 20004 @@ -32,7 +32,7 @@ The user can execute cash transaction commands to issue and move cash to other p Bank of Corda -> 20008 -##TODOs: +## TODOs: - Shows more useful information in the dashboard. - Improve Network View, display other nodes in the world map and show transactions between them. - Add a new view showing node's state machines.