Small doc fixes (#1669)

Co-authored-by: Amaury Chamayou <amchamay@microsoft.com>

doc/developers/index.rst

@@ -20,4 +20,5 @@ These endpoints mutate the state of a unique :ref:`developers/kv/index:Key-Value
   cryptography
   threading
   performance
+  upgrading_app
   api

doc/developers/upgrading_app.rst

@@ -7,7 +7,7 @@ The sample `logging application <https://github.com/microsoft/CCF/tree/master/sr
 
 .. note::
 
-    GitHub offers a convenient way to compare two releases via the following url ``https://github.com/microsoft/CCF/compare/<old_release>...<new_release>``, e.g. `<https://github.com/microsoft/CCF/compare/v0.7...v0.9.1>`_. The changes to the ``logging.cpp`` file should display the changes required to upgrade your application, including new features.
+    GitHub offers a convenient way to compare two releases via the following url ``https://github.com/microsoft/CCF/compare/<old_release>...<new_release>``, e.g. `<https://github.com/microsoft/CCF/compare/v0.13...v0.12>`_. The changes to the ``logging.cpp`` file should display the changes required to upgrade your application, including new features.
 
 .. warning::
 

doc/members/accept_recovery.rst

@@ -3,7 +3,7 @@ Accepting Recovery and Submitting Shares
 
 .. note:: Before members can initiate the end of the recovery procedure, operators should have started a new network and recovered all public transactions. See :ref:`details for public recovery operator procedure <operators/recovery:Establishing a Recovered Public Network>`.
 
-.. note:: See :ref:`users/deploy_app:Recovering a Service` for an automated way to recover a defunct CCF service.
+.. note:: See :ref:`operators/deploy_app:Recovering a Service` for an automated way to recover a defunct CCF service.
 
 Accepting Recovery
 ------------------

doc/operators/deploy_app.rst

@@ -1,7 +1,7 @@
-Deploying an Application
-========================
+Starting a Test Network
+=======================
 
-The quickest way to deploy a CCF application is to use the `start_test_network.sh <https://github.com/microsoft/CCF/blob/master/start_test_network.sh>`_ test script, specifying the :ref:`enclave image <developers/index:Building Apps>` to run.
+The quickest way to start a CCF test network is to use the `start_test_network.sh <https://github.com/microsoft/CCF/blob/master/start_test_network.sh>`_ test script, specifying the :ref:`enclave image <developers/index:Building Apps>` to run.
 
 The script creates a new test CCF network composed of 3 nodes running locally. All the governance requests required to open the network to users are automatically issued.
 
@@ -29,7 +29,7 @@ For example, deploying the ``liblogging`` example application:
     - The ``--verbose`` argument can be used to display all commands issued by operators and members to start the network.
     - Snapshots can be generated at regular intervals by the primary node of the service using the ``--snapshot-tx-interval <interval>`` option.
 
-The log files (``out`` and ``err``) and ledger (``<node_id>.ledger``) for each CCF node can be found under ``CCF/build/workspace/test_network_<node_id>``.
+The log files (``out`` and ``err``) and ledger directory (``<node_id>.ledger``) for each CCF node can be found under ``./workspace/test_network_<node_id>``.
 
 .. note:: The first time the command is run, a Python virtual environment will be created. This may take a few seconds. It will not be run the next time the ``start_test_network.sh`` script is started.
 

doc/operators/index.rst

@@ -9,6 +9,7 @@ This section describes how :term:`Operators` manage the different nodes constitu
 
     start_network
     recovery
+    deploy_app
     node_output
     operator_rpc_api
     resource_usage

doc/operators/ledger.rst

@@ -2,7 +2,7 @@ Ledger
 ======
 
 All network state is contained in the ledger. A single up-to-date copy of the ledger is enough to start a successor
-service if necessary, following the :ref:`operators/recovery:Catastrophic Recovery` procedure.
+service if necessary, following the :ref:`operators/recovery:Disaster Recovery` procedure.
 
 Each node in a network creates and maintains its own local copy of the ledger. Committed entries are always identical,
 but a node may be more or less up to date, and uncommitted entries may differ.

doc/operators/recovery.rst

@@ -1,5 +1,5 @@
-Catastrophic Recovery
-=====================
+Disaster Recovery
+=================
 
 For unexpected reasons, a significant number [#crash]_ of CCF nodes may become unavailable. In this catastrophic scenario, operators and members can recover transactions that were committed on the crashed service by starting a new network.
 
@@ -68,4 +68,4 @@ Once operators have established a recovered public network, the existing members
 
 .. rubric:: Footnotes
 
-.. [#crash] When using Raft as consensus algorithm, CCF tolerates up to `N/2 - 1` crashed nodes (where `N` is the number of nodes constituting the network) before having to perform the catastrophic recovery procedure. For example, in a 5-node network, no more than 2 nodes are allowed to fail.
+.. [#crash] When using Raft as consensus algorithm, CCF tolerates up to `N/2 - 1` crashed nodes (where `N` is the number of nodes constituting the network) before having to perform the recovery procedure. For example, in a 5-node network, no more than 2 nodes are allowed to fail.

doc/quickstart/build.rst

@@ -46,27 +46,6 @@ The full list of build switches can be obtained by running:
 * **COMPILE_TARGETS**: String. List of target compilation platforms. Defaults to ``sgx;virtual``, which builds both "virtual" enclaves and actual SGX enclaves.
 * **VERBOSE_LOGGING**: Boolean. Enable all logging levels. Default to OFF.
 
-Starting up a Test Network
---------------------------
-
-You can quickly spin up a CCF network and start :ref:`issuing commands to the deployed application <users/issue_commands:Issuing Commands>`:
-
-.. code-block:: bash
-
-    $ cd build
-    $ ../start_test_network.sh --package ./liblogging.enclave.so.signed
-    Setting up Python environment...
-    Python environment successfully setup
-    [14:47:41.562] Starting 3 CCF nodes...
-    [14:48:12.138] Started CCF network with the following nodes:
-    [14:48:12.138]   Node [ 0] = 127.177.10.108:37765
-    [14:48:12.138]   Node [ 1] = 127.169.74.37:58343
-    [14:48:12.138]   Node [ 2] = 127.131.108.179:50532
-    [14:48:12.138] You can now issue business transactions to the ./liblogging.enclave.so.signed application.
-    [14:48:12.138] Keys and certificates have been copied to the common folder: /data/src/CCF/build/workspace/test_network_common
-    [14:48:12.138] See https://microsoft.github.io/CCF/master/users/issue_commands.html for more information.
-    [14:48:12.138] Press Ctrl+C to shutdown the network.
-
 Running Tests
 -------------
 

doc/quickstart/index.rst

@@ -1,6 +1,12 @@
 Start Here
 ==========
 
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+
+    build
+
 Container
 ---------
 
@@ -110,8 +116,6 @@ Running CCF with full security guarantees requires :term:`SGX` hardware with :te
 Releases
 --------
 
-CCF releases (``ccf.tar.gz``) are available on the `GitHub repository release page <https://github.com/microsoft/CCF/releases>`_.
-Once downloaded, the extracted install directory can be copied to a long-lived path, e.g. under ``/opt/``.
+CCF releases (``ccf_<version>_amd64.deb``) are available on the `GitHub repository release page <https://github.com/microsoft/CCF/releases>`_.
 
-To setup a CI for your CCF application, you may want to use the :ref:`developers/build_app:Build Container`. If you are running
-CCF nodes in containers, the :ref:`operators/container:Runtime Container` is a good place to start.
+To setup a CI for your CCF application, you may want to use the :ref:`developers/build_app:Build Container`. If you are running CCF nodes in containers, the :ref:`operators/container:Runtime Container` is a good place to start.

doc/users/index.rst

@@ -18,7 +18,6 @@ Before issuing business transactions to CCF, the certificates of trusted users n
     :maxdepth: 2
     :caption: Contents:
 
-    deploy_app
     issue_commands
     verify_quote
     python_tutorial