Merge remote-tracking branch 'origin/release/3.3.0' into 4.0.0a1

docs/source/simulation_components/system/services/database_service.rst

@@ -94,11 +94,6 @@ Via Configuration
 Configuration
 =============
 
-.. include:: ../common/common_configuration.rst
-
-.. |SOFTWARE_NAME| replace:: DatabaseService
-.. |SOFTWARE_NAME_BACKTICK| replace:: ``DatabaseService``
-
 ``backup_server_ip``
 """"""""""""""""""""
 
@@ -114,3 +109,8 @@ This must be a valid octet i.e. in the range of ``0.0.0.0`` and ``255.255.255.25
 Optional. Default value is ``None``.
 
 The password that needs to be provided by connecting clients in order to create a successful connection.
+
+``Common Attributes``
+^^^^^^^^^^^^^^^^^^^^^
+
+See :ref:`Common Configuration`

docs/source/simulation_components/system/services/dns_client.rst

@@ -84,10 +84,6 @@ Via Configuration
 Configuration
 =============
 
-.. include:: ../common/common_configuration.rst
-
-.. |SOFTWARE_NAME| replace:: DNSClient
-.. |SOFTWARE_NAME_BACKTICK| replace:: ``DNSClient``
 
 ``dns_server``
 """"""""""""""
@@ -97,3 +93,8 @@ Optional. Default value is ``None``.
 The IP Address of the :ref:`DNSServer`.
 
 This must be a valid octet i.e. in the range of ``0.0.0.0`` and ``255.255.255.255``.
+
+``Common Attributes``
+^^^^^^^^^^^^^^^^^^^^^
+
+See :ref:`Common Configuration`

docs/source/simulation_components/system/services/dns_server.rst

@@ -83,16 +83,17 @@ Via Configuration
 Configuration
 =============
 
-.. include:: ../common/common_configuration.rst
 
-.. |SOFTWARE_NAME| replace:: DNSServer
-.. |SOFTWARE_NAME_BACKTICK| replace:: ``DNSServer``
-
-domain_mapping
-""""""""""""""
+``domain_mapping``
+""""""""""""""""""
 
 Domain mapping takes the domain and IP Addresses as a key-value pairs i.e.
 
 If the domain is "arcd.com" and the IP Address attributed to the domain is 192.168.0.10, then the value should be ``arcd.com: 192.168.0.10``
 
 The key must be a string and the IP Address must be a valid octet i.e. in the range of ``0.0.0.0`` and ``255.255.255.255``.
+
+``Common Attributes``
+^^^^^^^^^^^^^^^^^^^^^
+
+See :ref:`Common Configuration`

docs/source/simulation_components/system/services/ftp_client.rst

@@ -83,7 +83,7 @@ Via Configuration
 Configuration
 =============
 
-.. include:: ../common/common_configuration.rst
+``Common Attributes``
+^^^^^^^^^^^^^^^^^^^^^
 
-.. |SOFTWARE_NAME| replace:: FTPClient
-.. |SOFTWARE_NAME_BACKTICK| replace:: ``FTPClient``
+See :ref:`Common Configuration`

docs/source/simulation_components/system/services/ftp_server.rst

@@ -81,14 +81,14 @@ Via Configuration
 Configuration
 =============
 
-.. include:: ../common/common_configuration.rst
-
-.. |SOFTWARE_NAME| replace:: FTPServer
-.. |SOFTWARE_NAME_BACKTICK| replace:: ``FTPServer``
-
 ``server_password``
 """""""""""""""""""
 
 Optional. Default value is ``None``.
 
 The password that needs to be provided by a connecting :ref:`FTPClient` in order to create a successful connection.
+
+``Common Attributes``
+^^^^^^^^^^^^^^^^^^^^^
+
+See :ref:`Common Configuration`

docs/source/simulation_components/system/services/ntp_client.rst

@@ -80,11 +80,6 @@ Via Configuration
 Configuration
 =============
 
-.. include:: ../common/common_configuration.rst
-
-.. |SOFTWARE_NAME| replace:: NTPClient
-.. |SOFTWARE_NAME_BACKTICK| replace:: ``NTPClient``
-
 ``ntp_server_ip``
 """""""""""""""""
 
@@ -93,3 +88,8 @@ Optional. Default value is ``None``.
 The IP address of an NTP Server which provides a time that the ``NTPClient`` can synchronise to.
 
 This must be a valid octet i.e. in the range of ``0.0.0.0`` and ``255.255.255.255``.
+
+``Common Attributes``
+^^^^^^^^^^^^^^^^^^^^^
+
+See :ref:`Common Configuration`

docs/source/simulation_components/system/services/ntp_server.rst

@@ -75,10 +75,8 @@ Via Configuration
                     - ref: ntp_server
                     type: NTPServer
 
-Configuration
-=============
 
-.. include:: ../common/common_configuration.rst
+``Common Attributes``
+^^^^^^^^^^^^^^^^^^^^^
 
-.. |SOFTWARE_NAME| replace:: NTPServer
-.. |SOFTWARE_NAME_BACKTICK| replace:: ``NTPServer``
+See :ref:`Common Configuration`

docs/source/simulation_components/system/services/terminal.rst

@@ -23,13 +23,6 @@ Key capabilities
  - Simulates common Terminal processes/commands.
  - Leverages the Service base class for install/uninstall, status tracking etc.
 
-Usage
-"""""
-
- - Pre-Installs on any `Node` (component with the exception of `Switches`).
- - Terminal Clients connect, execute commands and disconnect from remote nodes.
- - Ensures that users are logged in to the component before executing any commands.
- - Service runs on SSH port 22 by default.
 
 Implementation
 """"""""""""""
@@ -40,6 +33,14 @@ Implementation
   - A detailed guide on the implementation and functionality of the Terminal class can be found in the "Terminal-Processing" jupyter notebook.
 
 
+Usage
+"""""
+
+ - Pre-Installs on all ``Nodes`` (with the exception of ``Switches``).
+ - Terminal Clients connect, execute commands and disconnect from remote nodes.
+ - Ensures that users are logged in to the component before executing any commands.
+ - Service runs on SSH port 22 by default.
+
 Usage
 =====
 
@@ -172,3 +173,9 @@ Disconnect from Remote Node
     term_a_term_b_remote_connection: RemoteTerminalConnection = terminal_a.login(username="admin", password="Admin123!", ip_address="192.168.0.11")
 
     term_a_term_b_remote_connection.disconnect()
+
+
+``Common Attributes``
+^^^^^^^^^^^^^^^^^^^^^
+
+See :ref:`Common Configuration`

docs/source/simulation_components/system/services/web_server.rst

@@ -75,10 +75,8 @@ Via Configuration
                     - ref: web_server
                     type: WebServer
 
-Configuration
-=============
 
-.. include:: ../common/common_configuration.rst
+``Common Attributes``
+^^^^^^^^^^^^^^^^^^^^^
 
-.. |SOFTWARE_NAME| replace:: WebServer
-.. |SOFTWARE_NAME_BACKTICK| replace:: ``WebServer``
+See :ref:`Common Configuration`