From 21a15ae8b6c97a3c77f35b9c2b97db0100ddd801 Mon Sep 17 00:00:00 2001 From: Chandrika Date: Mon, 3 Oct 2022 11:23:21 -0700 Subject: [PATCH] More rtd updates. updated broken links, cleaned up left side tree (#3044) --- .../vc-device-configuration-demo.rst | 62 ++++++++++--------- .../chargepoint/chargepoint-specification.rst | 2 +- .../python-for-matlab-users.rst | 2 +- docs/source/index.rst | 21 +------ docs/source/introduction/platform-install.rst | 21 +++---- .../rabbitmq/rabbitmq-volttron.rst | 2 +- 6 files changed, 43 insertions(+), 67 deletions(-) diff --git a/docs/source/agent-framework/core-service-agents/volttron-central/vc-device-configuration-demo.rst b/docs/source/agent-framework/core-service-agents/volttron-central/vc-device-configuration-demo.rst index 7a6758c497..02456fd820 100644 --- a/docs/source/agent-framework/core-service-agents/volttron-central/vc-device-configuration-demo.rst +++ b/docs/source/agent-framework/core-service-agents/volttron-central/vc-device-configuration-demo.rst @@ -9,22 +9,22 @@ enables device detection and configuration for BACnet devices. The following se with performing scans to detect physical devices and get their points, and configuring them as virtual devices installed on VOLTTRON instances. -- `Launching Device Configuration `__ -- `Scanning for Devices `__ -- `Scanning for Points `__ -- `Registry Configuration File `__ -- `Additional Attributes `__ -- `Quick Edit Features `__ -- `Keyboard Commands `__ -- `Registry Preview `__ -- `Registry Configuration Options `__ -- `Reloading Device Points `__ -- `Device Configuration Form `__ -- `Configuring Sub-devices `__ -- `Reconfiguring Devices `__ -- `Exporting Registry Configuration Files `__ - - +- `Launching Device Configuration`_ +- `Scanning for Devices`_ +- `Scanning for Points`_ +- `Registry Configuration File`_ +- `Additional Attributes`_ +- `Quick Edit Features`_ +- `Keyboard Commands`_ +- `Registry Preview`_ +- `Registry Configuration Options`_ +- `Reloading Device Points`_ +- `Device Configuration Form`_ +- `Configuring Sub-devices`_ +- `Reconfiguring Devices`_ +- `Exporting Registry Configuration Files`_ + +.. _launching-device-configuration: Launching Device Configuration ------------------------------ @@ -45,7 +45,7 @@ device IDs will limit the scan to return only devices with IDs in that range. A specify the IP address of a device to detect as well as the ability to change the duration of the scan from the default of five seconds. - +.. _scanning-for-devices: Scanning for Devices -------------------- @@ -58,7 +58,7 @@ clicking the large cog button again. |Devices Found| - +.. _scanning-for-points: Scanning for Points ------------------- @@ -73,9 +73,9 @@ After the points have been retrieved once, the only way to scan the same device device configuration process from the start by clicking on the small cogs button next to the platform instance in the panel tree. - +.. _registry-configuration-file: Registry Configuration File -^^^^^^^^^^^^^^^^^^^^^^^^^^^ +---------------------------- The registry configuration determines which points on the physical device will be associated with the virtual device that uses that particular registry configuration. The registry configuration determines which points' data will be @@ -100,7 +100,7 @@ Type directly in a cell to change an attribute value for a point. |Edit Points| - +.. _additional-attributes: Additional Attributes --------------------- @@ -118,7 +118,7 @@ In the window that opens, point attributes can be changed by typing in the field Checking or unchecking the `Show in Table` box for an attribute will add or remove it as a column in the registry configuration editor. - +.. _quick-edit-features: Quick Edit Features ------------------- @@ -188,7 +188,7 @@ To quickly replace the matched term in the cell with focus, type a replacement t To replace all the matched terms in the column, click on the `Replace All` button. Click the `Clear Search` button to end the search. - +.. _keyboard-commands: Keyboard Commands ----------------- @@ -222,7 +222,7 @@ Click on the `Keyboard Shortcuts` button to show a popup list of the available k |Keyboard Shortcuts| - +.. _registry-preview: Registry Preview ---------------- @@ -244,7 +244,7 @@ Provide a name for the registry configuration file, and click the `Save` button |Registry Saved| - +.. _registry-configuration-options: Registry Configuration Options ------------------------------ @@ -269,7 +269,7 @@ use the file selector window to locate and load the file. |File Import Button| - +.. _reloading-device-points: Reloading Device Points ----------------------- @@ -278,7 +278,7 @@ configuration by clicking on the `Reload Points From Device` button at the end o |Reload Points| - +.. _device-configuration-form: Device Configuration Form ^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -295,7 +295,7 @@ device to the platform. |Device Added| - +.. _configuring-sub-devices: Configuring Sub-devices ----------------------- @@ -311,18 +311,20 @@ As devices are configured, they're inserted into position in the side panel tree |Device Added to Tree| - +.. _reconfiguring-devices: Reconfiguring Devices ^^^^^^^^^^^^^^^^^^^^^ A device that's been added to a VOLTTRON instance can be reconfigured by changing its registry configuration or its device configuration. To launch reconfiguration, click on the wrench button next to the device in the side panel tree. +.. _reconfigure-device-button: |Reconfigure Device Button| Reconfiguration reloads the registry configuration editor and the device configuration form for the virtual device. The editor and the form work the same way in reconfiguration as during initial device configuration. +.. _reconfiguring-device: |Reconfiguring Device| The reconfiguration view shows the name, address, and ID of the physical device that the virtual device was configured @@ -341,7 +343,7 @@ To make changes to the device configuration form, click on the `File to Edit` se |Reconfigure Device Config| - +.. _exporting-registry-configuration-files: Exporting Registry Configuration Files -------------------------------------- diff --git a/docs/source/agent-framework/driver-framework/chargepoint/chargepoint-specification.rst b/docs/source/agent-framework/driver-framework/chargepoint/chargepoint-specification.rst index 16c2b6d0ee..4e2cf17bcf 100644 --- a/docs/source/agent-framework/driver-framework/chargepoint/chargepoint-specification.rst +++ b/docs/source/agent-framework/driver-framework/chargepoint/chargepoint-specification.rst @@ -432,7 +432,7 @@ VOLTTRON installation: .. - https://bitbucket.org/jurko/suds + https://pypi.org/project/suds-jurko/ Is there a mechanism for drivers to specify their own requirements.txt ? diff --git a/docs/source/developing-volttron/python-for-matlab-users.rst b/docs/source/developing-volttron/python-for-matlab-users.rst index 289c874be2..0e24533302 100644 --- a/docs/source/developing-volttron/python-for-matlab-users.rst +++ b/docs/source/developing-volttron/python-for-matlab-users.rst @@ -184,7 +184,7 @@ More Resources -------------- `NumPy for Matlab Users -`_ +`_ Has a nice list of common operations in Matlab and NumPy. `NumPy Homepage diff --git a/docs/source/index.rst b/docs/source/index.rst index 1106bb3853..6bdc1ac7a2 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -56,7 +56,6 @@ at our bi-weekly office-hours and on Slack. To be invited to office-hours or sla introduction/definitions introduction/license - .. toctree:: :caption: Platform Features :hidden: @@ -69,7 +68,6 @@ at our bi-weekly office-hours and on Slack. To be invited to office-hours or sla platform-features/security/volttron-security platform-features/web-api/introduction - .. toctree:: :caption: Agent Framework :hidden: @@ -86,7 +84,6 @@ at our bi-weekly office-hours and on Slack. To be invited to office-hours or sla agent-framework/platform-service-standardization agent-framework/third-party-agents - .. toctree:: :caption: Developing in VOLTTRON :hidden: @@ -102,7 +99,6 @@ at our bi-weekly office-hours and on Slack. To be invited to office-hours or sla developing-volttron/jupyter/jupyter-notebooks developing-volttron/python-for-matlab-users - .. toctree:: :caption: Deploying VOLTTRON :hidden: @@ -118,18 +114,6 @@ at our bi-weekly office-hours and on Slack. To be invited to office-hours or sla deploying-volttron/linux-system-hardening deploying-volttron/recipe-deployment - - -.. toctree:: - :caption: Driver Framework - :hidden: - :titlesonly: - :maxdepth: 1 - - driver-framework/drivers-overview - - - .. toctree:: :caption: VOLTTRON Core Service Agents :hidden: @@ -139,7 +123,6 @@ at our bi-weekly office-hours and on Slack. To be invited to office-hours or sla volttron-api/services/*/modules - .. toctree:: :caption: VOLTTRON Core Operations Agents :hidden: @@ -149,7 +132,6 @@ at our bi-weekly office-hours and on Slack. To be invited to office-hours or sla volttron-api/ops/*/modules - .. toctree:: :caption: VOLTTRON Topics :hidden: @@ -159,7 +141,6 @@ at our bi-weekly office-hours and on Slack. To be invited to office-hours or sla Releases volttron-topics/troubleshooting/index volttron-topics/volttron-applications/index - .. toctree:: :caption: Tutorials @@ -167,7 +148,7 @@ at our bi-weekly office-hours and on Slack. To be invited to office-hours or sla :titlesonly: :maxdepth: 1 - tutorials/quick-start + tutorials/quick-start Indices and tables diff --git a/docs/source/introduction/platform-install.rst b/docs/source/introduction/platform-install.rst index d8ec9acd99..c17e1f0d74 100644 --- a/docs/source/introduction/platform-install.rst +++ b/docs/source/introduction/platform-install.rst @@ -10,7 +10,7 @@ Installing the Platform VOLTTRON is written in Python 3.6+ and runs on Linux Operating Systems. For users unfamiliar with those technologies, the following resources are recommended: -- `Python 3.6 Tutorial `_ +- `Python 3.6 Tutorial `_ - `Linux Tutorial `_ This guide will specify commands to use to successfully install the platform on supported Linux distributions, but a @@ -195,22 +195,17 @@ Step 2 - Install Erlang packages For RabbitMQ based VOLTTRON, some of the RabbitMQ specific software packages have to be installed. -On Debian based systems and CentOS 6/7 -"""""""""""""""""""""""""""""""""""""" +On Debian based systems and CentOS 8 +"""""""""""""""""""""""""""""""""""" -If you are running a Debian or CentOS system, you can install the RabbitMQ dependencies by running the +If you are running a Debian or CentOS 8 system, you can install the RabbitMQ dependencies by running the "rabbit_dependencies.sh" script, passing in the OS name and appropriate distribution as parameters. The following are supported: * `debian bionic` (for Ubuntu 18.04) -* `debian xenial` (for Ubuntu 16.04 or Linux Mint 18.04) +* `debian focal` (for Ubuntu 20.04) -* `debian stretch` (for Debian Stretch) - -* `debian buster` (for Debian Buster) - -* `raspbian buster` (for Raspbian/Raspberry Pi OS Buster) Example command: @@ -228,10 +223,8 @@ Also lock your version of Erlang using the `yum-plugin-versionlock `_ + * 1:24.1.7-1 for Debian + * 24.2-1.el8 for CentOS 8 Step 3 - Configure hostname diff --git a/docs/source/platform-features/message-bus/rabbitmq/rabbitmq-volttron.rst b/docs/source/platform-features/message-bus/rabbitmq/rabbitmq-volttron.rst index e5d7674eee..249b382cd7 100644 --- a/docs/source/platform-features/message-bus/rabbitmq/rabbitmq-volttron.rst +++ b/docs/source/platform-features/message-bus/rabbitmq/rabbitmq-volttron.rst @@ -67,7 +67,7 @@ These needs to be set appropriately if the default ports are not used. The 'ssl' flag indicates if SSL based authentication is required or not. If set to `True`, information regarding SSL certificates needs to be also provided. SSL based authentication is described in detail in -`Authentication And Authorization With RabbitMQ Message Bus `_. +:ref:`Authentication And Authorization With RabbitMQ Message Bus `. To configure the VOLTTRON instance to use RabbitMQ message bus, run the following command: