Resolved latest conversations

ansible · Jan 31, 2024 · ec53883 · ec53883
1 parent d61bb8a
commit ec53883
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 18 deletions.
diff --git a/docs/source/getting_started_guide/creating_a_basic_network.rst b/docs/source/getting_started_guide/creating_a_basic_network.rst
@@ -16,6 +16,7 @@ Receptor configurations
 ***********************
 
 1. Create three configuration files, one for each node.
+
  **foo.yml**
 
 .. code-block:: yaml
@@ -78,21 +79,21 @@ Receptor configurations
       allowruntimeparams: true
     ...
 
-2. Run the services in separate terminals.
+1. Run the services in separate terminals.
 
-.. code-block: bash
+.. code-block:: bash
 
     ./receptor --config foo.yml
 
-.. code-block: bash
+.. code-block:: bash
 
     ./receptor --config bar.yml
 
-.. code-block: bash
+.. code-block:: bash
 
     ./receptor --config mal.yml
 
 .. seealso::
 
-    :ref: `Configuring Receptor with a config file <https://ansible.readthedocs.io/projects/receptor/en/latest/user_guide/basic_usage.html#configuring-receptor-with-a-config-file>`_
-    :ref: `Connecting Nodes <https://ansible.readthedocs.io/projects/receptor/en/latest/user_guide/connecting_nodes.html>`_
+    :ref: `configuring_receptor_with_a_config_file`
+    :ref: `connecting_nodes`
diff --git a/docs/source/getting_started_guide/index.rst b/docs/source/getting_started_guide/index.rst
@@ -24,7 +24,7 @@ transient network failures.
 
     :ref:`glossary`
         Receptor glossary
-    :ref: `Interacting with nodes <https://ansible.readthedocs.io/projects/receptor/en/latest/user_guide/interacting_with_nodes.html>`
+    :ref: `interacting_with_nodes`
         Further examples of working with nodes
-    :ref: `Connecting nodes<https://ansible.readthedocs.io/projects/receptor/en/latest/user_guide/connecting_nodes.html>`_
+    :ref: `connecting_nodes`
         Detail on connecting receptor nodes
diff --git a/docs/source/getting_started_guide/installing_receptor.rst b/docs/source/getting_started_guide/installing_receptor.rst
@@ -10,5 +10,5 @@ Installing Receptor
 
 .. seealso::
 
-    :ref: `Receptor Installation <https://ansible.readthedocs.io/projects/receptor/en/latest/installation.html>`_
-    :ref: `Using Receptor Containers <https://ansible.readthedocs.io/projects/receptor/en/latest/user_guide/basic_usage.html#use-receptor-through-a-container-image>`_
+    :ref: `installing`
+    :ref: `using_receptor_containers`
diff --git a/docs/source/getting_started_guide/introduction.rst b/docs/source/getting_started_guide/introduction.rst
@@ -6,11 +6,11 @@ Receptor is an overlay network.
 It eases the work distribution across a large and dispersed collection
 of workers
 
-Receptor nodes establish peer-to-peer connections with each other via
+Receptor nodes establish peer-to-peer connections with each other through
 existing networks
 
 Once connected, the receptor mesh provides:
 
 * Datagram (UDP-like) and stream (TCP-like) capabilities to applications
 * Robust unit-of-work handling
-* Resiliency against transient network failures.
+* Resiliency against transient network failures
diff --git a/docs/source/getting_started_guide/trying_sample_commands.rst b/docs/source/getting_started_guide/trying_sample_commands.rst
@@ -8,31 +8,31 @@ Try Sample Commands
 
     receptorctl --socket /tmp/foo.sock status
 
-1. Ping node mal from node foo
+2. Ping node mal from node foo
 
 .. code-block:: bash
 
     receptorctl --socket /tmp/foo.sock ping mal
 
-1. Submit work from foo to mal and stream results back to foo
+3. Submit work from foo to mal and stream results back to foo
 
 .. code-block:: bash
 
     seq 10 | receptorctl --socket /tmp/foo.sock work submit --node mal echo --payload - -f
 
-1. List work units
+4. List work units
 
 .. code-block:: bash
 
     receptorctl --socket /tmp/foo.sock work list --node foo
 
-1. Get work unit id using jq
+5. Get work unit id using jq
 
 .. code-block:: bash
 
     receptorctl --socket /tmp/foo.sock work list --node foo | jq --raw-output '.|keys|first'
 
-1. Re-stream the work results from work unit
+6. Re-stream the work results from work unit
 
 .. code-block:: bash
 
@@ -42,4 +42,4 @@ Congratulations, you are now using Receptor!
 
 .. seealso::
 
-    :ref: `Receptor control service commands <https://ansible.readthedocs.io/projects/receptor/en/latest/user_guide/interacting_with_nodes.html#control-service-commands>`_
+    :ref: `control_service_commands`
diff --git a/docs/source/user_guide/basic_usage.rst b/docs/source/user_guide/basic_usage.rst
@@ -21,6 +21,7 @@ Supported log levels, in increasing verbosity, are Error, Warning, Info and Debu
 
 Note: stop the receptor process with ``ctrl-c``
 
+.. _configuring_receptor_with_a_config_file::
 Configuring Receptor with a config file
 ----------------------------------------
 
@@ -45,6 +46,7 @@ Start receptor using the config file
 
 Changing the configuration file does take effect until the receptor process is restarted.
 
+:: _using_receptor_containers::
 Use Receptor through a container image
 ---------------------------------------
 

diff --git a/docs/source/user_guide/connecting_nodes.rst b/docs/source/user_guide/connecting_nodes.rst
@@ -1,3 +1,4 @@
+.. _connecting_nodes::
 Connecting nodes
 ================
 

diff --git a/docs/source/user_guide/interacting_with_nodes.rst b/docs/source/user_guide/interacting_with_nodes.rst
@@ -1,5 +1,6 @@
 
 
+.. _interacting_with_nodes::
 Interacting with nodes
 ======================
 
@@ -109,6 +110,7 @@ Once connected to a control service, one can issue commands like "status" or "wo
 
 Keep in mind that a "work submit" command will require a payload. Type out the payload contents and press ctrl-D to send the EOF signal. The socket will then close and work will begin. See :ref:`workceptor` for more on submitting work via receptor.
 
+:: _control_service_commands::
 Control service commands
 --------------------------