Add page for Elastic dashboard (#2857)

wpilibsuite · Dec 1, 2024 · b8c09b0 · b8c09b0
1 parent d22a67d
commit b8c09b0
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 1 deletion.
diff --git a/source/docs/software/dashboards/elastic.rst b/source/docs/software/dashboards/elastic.rst
@@ -0,0 +1,18 @@
+# Elastic
+
+Elastic is a simple and modern dashboard made by Team 353. It is meant to serve as a dashboard for competition but can also be used for testing. It was built with the goal of being a drag & drop dashboard with an easy setup and elegant UI designed for a high pressure competition environment.
+
+In Visual Studio Code, press :kbd:`Ctrl+Shift+P` and type ``WPILib`` or click the WPILib logo in the top right to launch the WPILib Command Palette. Select :guilabel:`Start Tool`, then select :guilabel:`Elastic`.
+
+.. note:: Detailed documentation for Elastic can be found [here](https://frc-elastic.gitbook.io/docs).
+
+The capabilities of Elastic include:
+
+- Viewing data from different NT4 topics and widgets
+- Draggable and resizable card widgets
+- Customizable color scheme
+- Automatic IP retrieval from the FRC Driver Station
+- Compatibility with the WPILib Shuffleboard API
+
+.. image:: images/elastic.png
+   :alt: Screenshot of an Elastic showing field trajectory, match time, and several other widgets
diff --git a/source/docs/software/dashboards/images/elastic.png b/source/docs/software/dashboards/images/elastic.png
diff --git a/...dashboards/images/troubleshooting-dashboard-connectivity/elastic-connection.png b/...dashboards/images/troubleshooting-dashboard-connectivity/elastic-connection.png
diff --git a/source/docs/software/dashboards/index.rst b/source/docs/software/dashboards/index.rst
@@ -8,5 +8,6 @@
    smartdashboard/index
    glass/index
    advantagescope.rst
+   elastic.rst
    labview-dashboard/index
    troubleshooting-dashboard-connectivity.rst
diff --git a/source/docs/software/dashboards/troubleshooting-dashboard-connectivity.rst b/source/docs/software/dashboards/troubleshooting-dashboard-connectivity.rst
@@ -46,6 +46,13 @@ Glass indicates if it is connected or not in the title bar. It shows the IP addr
 
 AdvantageScope indicates if it is connected or not in the title bar. It shows the IP address it is connected to, or else the IP address it is attempting to connect to. See the [AdvantageScope Documentation](https://docs.advantagescope.org/getting-started/connect-live) for more on configuring the connection.
 
+## Recognizing Elastic Connectivity
+
+.. image:: images/troubleshooting-dashboard-connectivity/elastic-connection.png
+   :alt: The lower left corner of Elastic showing a connection to localhost
+
+Elastic indicates if it is connected or not in the lower left corner. It shows what it is connected to. See the [Elastic Documentation](https://frc-elastic.gitbook.io/docs/getting-started/connecting-to-your-robot) for more on configuring the connection.
+
 ## Troubleshooting Connectivity
 
 If the Dashboard does not connect to the Robot (after the Driver Station has connected to the robot) the recommended troubleshooting steps are:

diff --git a/source/docs/yearly-overview/yearly-changelog.rst b/source/docs/yearly-overview/yearly-changelog.rst
@@ -239,4 +239,4 @@ Choreo is bundled in the installer! Choreo is an application for creating time o
 
 ## Elastic
 
-Elastic is bundled in the installer! Elastic is a simple and modern dashboard.
+Elastic is bundled in the installer! Elastic is a simple and modern dashboard. :doc:`Read more here </docs/software/dashboards/elastic>`.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -239,4 +239,4 @@ Choreo is bundled in the installer! Choreo is an application for creating time o

		## Elastic

		Elastic is bundled in the installer! Elastic is a simple and modern dashboard.
		Elastic is bundled in the installer! Elastic is a simple and modern dashboard. :doc:`Read more here </docs/software/dashboards/elastic>`.