ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-02-21 17:56:54 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

CORDA-2781 - Replace manual versions with substitutions (#4927)

Browse Source 
* been through the docs manually and picked out substitutions

* hopefully addressing the url inconsistencies
This commit is contained in:
Ben Wyeth 2019-03-25 12:20:26 +00:00 committed by Katelyn Baker
parent 1128156153
commit 08c4f1a2fb
3 changed files with 12 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/generating-a-node.rst
View File

@ -17,7 +17,7 @@ A node can be created manually by creating a folder that contains the following
* **Optional:** A webserver JAR entitled ``corda-webserver.jar`` that will connect to the node via RPC * **Optional:** A webserver JAR entitled ``corda-webserver.jar`` that will connect to the node via RPC
* The (deprecated) default webserver can be downloaded from http://r3.bintray.com/corda/net/corda/corda-webserver/ (under /|corda_version|/corda-webserver-|corda_version|.jar) * The (deprecated) default webserver can be downloaded from http://r3.bintray.com/corda/net/corda/corda-webserver/ (under /|corda_version|/corda-|corda_version|.jar)
* A Spring Boot alternative can be found here: https://github.com/corda/spring-webserver * A Spring Boot alternative can be found here: https://github.com/corda/spring-webserver
The remaining files and folders described in :doc:`node-structure` will be generated at runtime. The remaining files and folders described in :doc:`node-structure` will be generated at runtime.

20
docs/source/network-bootstrapper.rst
View File

@ -29,9 +29,7 @@ The Corda Network Bootstrapper can be downloaded from `here <https://www.corda.n
Create a directory containing a node config file, ending in "_node.conf", for each node you want to create. "devMode" must be set to true. Then run the Create a directory containing a node config file, ending in "_node.conf", for each node you want to create. "devMode" must be set to true. Then run the
following command: following command:
.. sourcecode:: bash ``java -jar network-bootstrapper-|corda_version|.jar --dir <nodes-root-dir>``
java -jar corda-tools-network-bootstrapper-|corda_version|.jar --dir <nodes-root-dir>
For example running the command on a directory containing these files: For example running the command on a directory containing these files:
@ -155,9 +153,7 @@ can use the Network Bootstrapper on the following network structure:
Then run the Network Bootstrapper again from the root dir: Then run the Network Bootstrapper again from the root dir:
.. sourcecode:: bash ``java -jar network-bootstrapper-|corda_version|.jar --dir <nodes-root-dir>``
java -jar corda-tools-network-bootstrapper-|corda_version|.jar --dir <nodes-root-dir>
Which will give the following: Which will give the following:
@ -228,9 +224,7 @@ For example, with the following pre-generated network:
Then run the Network Bootstrapper again from the root dir: Then run the Network Bootstrapper again from the root dir:
.. sourcecode:: bash ``java -jar network-bootstrapper-|corda_version|.jar --dir <nodes-root-dir>``
java -jar corda-tools-network-bootstrapper-|corda_version|.jar --dir <nodes-root-dir>
To give the following: To give the following:
@ -277,15 +271,11 @@ Overriding network parameters via a file
You can provide a network parameters overrides file using the following syntax: You can provide a network parameters overrides file using the following syntax:
.. sourcecode:: bash ``java -jar network-bootstrapper-|corda_version|.jar --network-parameter-overrides=<path_to_file>``
java -jar corda-tools-network-bootstrapper-|corda_version|.jar --network-parameter-overrides=<path_to_file>
Or alternatively, by using the short form version: Or alternatively, by using the short form version:
.. sourcecode:: bash ``java -jar network-bootstrapper-|corda_version|.jar -n=<path_to_file>``
java -jar corda-tools-network-bootstrapper-|corda_version|.jar -n=<path_to_file>
The network parameter overrides file is a HOCON file with the following fields, all of which are optional. Any field that is not provided will be The network parameter overrides file is a HOCON file with the following fields, all of which are optional. Any field that is not provided will be
ignored. If a field is not provided and you are bootstrapping a new network, a sensible default value will be used. If a field is not provided and you ignored. If a field is not provided and you are bootstrapping a new network, a sensible default value will be used. If a field is not provided and you

12
docs/source/testnet-explorer-corda.rst
View File

@ -34,21 +34,21 @@ couple of resources.
.. code:: bash .. code:: bash
wget https://ci-artifactory.corda.r3cev.com/artifactory/corda-releases/net/corda/corda-finance-contracts/|corda_version|/corda-finance-contracts-|corda_version|.jar wget https://ci-artifactory.corda.r3cev.com/artifactory/corda-releases/net/corda/corda-finance-contracts-|corda_version|-corda/corda-finance-contracts-|corda_version|-corda.jar
wget https://ci-artifactory.corda.r3cev.com/artifactory/corda-releases/net/corda/corda-finance-workflows/|corda_version|/corda-finance-workflows-|corda_version|.jar wget https://ci-artifactory.corda.r3cev.com/artifactory/corda-releases/net/corda/corda-finance-workflows-|corda_version|-corda/corda-finance-workflows-|corda_version|-corda.jar
This is required to run some flows to check your connections, and to issue/transfer cash to counterparties. Copy it to This is required to run some flows to check your connections, and to issue/transfer cash to counterparties. Copy it to
the Corda installation location: the Corda installation location:
.. code:: bash .. code:: bash
sudo cp /home/<USER>/corda-finance-*-|corda_version|.jar /opt/corda/cordapps/ sudo cp /home/<USER>/corda-finance-|corda_version|-corda.jar /opt/corda/cordapps/
#. Run the following to create a config file for the finance CorDapp: #. Run the following to create a config file for the finance CorDapp:
.. code:: bash .. code:: bash
echo "issuableCurrencies = [ USD ]" > /opt/corda/cordapps/config/corda-finance-|corda_version|.conf echo "issuableCurrencies = [ USD ]" > /opt/corda/cordapps/config/corda-finance-|corda_version|-corda.conf
#. Restart the Corda node: #. Restart the Corda node:
@ -70,7 +70,7 @@ couple of resources.
.. code:: bash .. code:: bash
http://ci-artifactory.corda.r3cev.com/artifactory/corda-releases/net/corda/corda-tools-explorer/|corda_version|/corda-tools-explorer-|corda_version|.jar http://ci-artifactory.corda.r3cev.com/artifactory/corda-releases/net/corda/corda-tools-explorer/|corda_version|-corda/corda-tools-explorer-|corda_version|-corda.jar
.. warning:: This Node Explorer is incompatible with the Corda Enterprise distribution and vice versa as they currently .. warning:: This Node Explorer is incompatible with the Corda Enterprise distribution and vice versa as they currently
use different serialisation schemes (Kryo vs AMQP). use different serialisation schemes (Kryo vs AMQP).
@ -79,7 +79,7 @@ couple of resources.
.. code:: bash .. code:: bash
java -jar corda-tools-explorer-|corda_version|.jar java -jar corda-tools-explorer-|corda_version|-corda.jar
.. image:: resources/explorer-login.png .. image:: resources/explorer-login.png