Merge branch 'main' into no_period

OpenC3 · Nov 14, 2024 · 80d29b5 · 80d29b5
2 parents 21e61b8 + be0a654
commit 80d29b5
Show file tree

Hide file tree

Showing 946 changed files with 13,015 additions and 13,812 deletions.
diff --git a/.env b/.env
@@ -82,3 +82,6 @@ OPENC3_AWS_ARN_PREFIX=arn:aws
 # OPENC3_NO_TOOLADMIN=1
 # OPENC3_NO_BUCKETEXPLORER=1
 # OPENC3_NO_DOCS=1
+
+# Enables the --trusted-host flag when downloading python package from the PYPI_URL
+# PIP_ENABLE_TRUSTED_HOST=1
diff --git a/.github/workflows/playwright.yml b/.github/workflows/playwright.yml
@@ -61,7 +61,7 @@ jobs:
         working-directory: playwright
       - name: Run Playwright tests
         # Run separately to allow for parallelism
-        run: ./playwright.sh run-chromium --grep-invert enterprise
+        run: ./playwright.sh run-chromium --grep-invert='enterprise'
         working-directory: playwright
       - name: Generate coverage
         run: yarn fixlinux; yarn cobertura

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -110,7 +110,7 @@ jobs:
         env:
           GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
       - name: Publish python package
-        uses: pypa/gh-action-pypi-publish@f7600683efdcb7656dec5b29656edb7bc586e597
+        uses: pypa/gh-action-pypi-publish@fb13cb306901256ace3dab689990e13a5550ffaa
         with:
           user: __token__
           password: ${{ secrets.PYPI_API_TOKEN }}

diff --git a/.whitelist b/.whitelist
@@ -1,3 +1,5 @@
 assertin
 xdescribe
-xit
+xit
+beforeAll
+afterAll
diff --git a/docs.openc3.com/docs/configuration/_command.md b/docs.openc3.com/docs/configuration/_command.md
@@ -1,6 +1,9 @@
 ---
 sidebar_position: 4
 title: Commands
+description: Command definition file format and keywords
+sidebar_custom_props:
+  myEmoji: 📡
 ---
 
 <!-- Be sure to edit _command.md because command.md is a generated file -->

diff --git a/docs.openc3.com/docs/configuration/_plugins.md b/docs.openc3.com/docs/configuration/_plugins.md
@@ -1,6 +1,9 @@
 ---
 sidebar_position: 2
 title: Plugins
+description: Plugin definition file format and keywords
+sidebar_custom_props:
+  myEmoji: 🔌
 ---
 
 <!-- Be sure to edit _plugins.md because plugins.md is a generated file -->

diff --git a/docs.openc3.com/docs/configuration/_table.md b/docs.openc3.com/docs/configuration/_table.md
@@ -1,6 +1,7 @@
 ---
 sidebar_position: 8
 title: Tables
+description: Table definition file format and keywords
 ---
 
 <!-- Be sure to edit _table.md because table.md is a generated file -->

diff --git a/docs.openc3.com/docs/configuration/_target.md b/docs.openc3.com/docs/configuration/_target.md
@@ -1,6 +1,9 @@
 ---
 sidebar_position: 3
 title: Targets
+description: Target definition file format and keywords
+sidebar_custom_props:
+  myEmoji: 🛰️
 ---
 
 <!-- Be sure to edit _target.md because target.md is a generated file -->

diff --git a/docs.openc3.com/docs/configuration/_telemetry-screens.md b/docs.openc3.com/docs/configuration/_telemetry-screens.md
@@ -1,6 +1,9 @@
 ---
 sidebar_position: 9
 title: Screens
+description: Telemetry Viewer screen definition and widget documentation
+sidebar_custom_props:
+  myEmoji: 🖥️
 ---
 
 <!-- Be sure to edit _telemetry_screens.md because telemetry_screens.md is a generated file -->

diff --git a/docs.openc3.com/docs/configuration/_telemetry.md b/docs.openc3.com/docs/configuration/_telemetry.md
@@ -1,6 +1,9 @@
 ---
 sidebar_position: 5
 title: Telemetry
+description: Telemetry definition file format and keywords
+sidebar_custom_props:
+  myEmoji: 📡
 ---
 
 <!-- Be sure to edit _telemetry.md because telemetry.md is a generated file -->

diff --git a/docs.openc3.com/docs/configuration/command.md b/docs.openc3.com/docs/configuration/command.md
@@ -1,6 +1,9 @@
 ---
 sidebar_position: 4
 title: Commands
+description: Command definition file format and keywords
+sidebar_custom_props:
+  myEmoji: 📡
 ---
 
 <!-- Be sure to edit _command.md because command.md is a generated file -->
@@ -633,6 +636,12 @@ Generally the template file is formatted in JSON or HTML and then values are fil
 Used for packet definitions that can be used as structures for items with a given packet.
 
 
+### RESTRICTED
+<div class="right">(Since 5.20.0)</div>**Marks this packet as restricted and will require approval if critical commanding is enabled**
+
+Used as one of the two types of critical commands (HAZARDOUS and RESTRICTED)
+
+
 ### VALIDATOR
 <div class="right">(Since 5.19.0)</div>**Defines a validator class for a command**
 

diff --git a/docs.openc3.com/docs/configuration/format.md b/docs.openc3.com/docs/configuration/format.md
@@ -1,6 +1,7 @@
 ---
 sidebar_position: 1
 title: File Format
+description: Structure of a COSMOS file, including using ERB
 ---
 
 COSMOS configuration files are just text files. They can (and should) be checked into your configuration management system and thus can be easily diffed throughout their history. They support ERB syntax, partials, and various line continuations which make them extremely flexible.

diff --git a/docs.openc3.com/docs/configuration/interfaces.md b/docs.openc3.com/docs/configuration/interfaces.md
@@ -1,6 +1,9 @@
 ---
 sidebar_position: 6
 title: Interfaces
+description: Built-in COSMOS interfaces including how to create one
+sidebar_custom_props:
+  myEmoji: 💡
 ---
 
 Interfaces are the connection to the external embedded systems called targets. Interfaces are defined by the top level [INTERFACE](plugins.md#interface-1) keyword in the plugin.txt file.

diff --git a/docs.openc3.com/docs/configuration/plugins.md b/docs.openc3.com/docs/configuration/plugins.md
@@ -1,6 +1,9 @@
 ---
 sidebar_position: 2
 title: Plugins
+description: Plugin definition file format and keywords
+sidebar_custom_props:
+  myEmoji: 🔌
 ---
 
 <!-- Be sure to edit _plugins.md because plugins.md is a generated file -->

diff --git a/docs.openc3.com/docs/configuration/protocols.md b/docs.openc3.com/docs/configuration/protocols.md
@@ -1,6 +1,9 @@
 ---
 sidebar_position: 7
 title: Protocols
+description: Built-in COSMOS protocols including how to create one
+sidebar_custom_props:
+  myEmoji: 💡
 ---
 
 Protocols process data on behalf of an Interface. They can modify the data being written, data being read, or both. Protocols can also mark a packet as stored instead of real-time which means COSMOS will not update the current value table with the packet data. Protocols can be layered and will be processed in order. For example, if you have a low-level encryption layer that must be first removed before processing a higher level buffer length protocol.

diff --git a/docs.openc3.com/docs/configuration/ssl-tls.md b/docs.openc3.com/docs/configuration/ssl-tls.md
@@ -1,6 +1,9 @@
 ---
 sidebar_position: 10
 title: SSL-TLS
+description: How to configure SSL and TLS
+sidebar_custom_props:
+  myEmoji: 🔐
 ---
 
 COSMOS 5 is a container based service which does not use SSL/TLS out of the box. This guide will help you configure SSL and TLS. Learn more at the Traefik [docs](https://doc.traefik.io/traefik/routing/entrypoints/#tls).

diff --git a/docs.openc3.com/docs/configuration/table.md b/docs.openc3.com/docs/configuration/table.md
@@ -1,6 +1,7 @@
 ---
 sidebar_position: 8
 title: Tables
+description: Table definition file format and keywords
 ---
 
 <!-- Be sure to edit _table.md because table.md is a generated file -->

diff --git a/docs.openc3.com/docs/configuration/target.md b/docs.openc3.com/docs/configuration/target.md
@@ -1,6 +1,9 @@
 ---
 sidebar_position: 3
 title: Targets
+description: Target definition file format and keywords
+sidebar_custom_props:
+  myEmoji: 🛰️
 ---
 
 <!-- Be sure to edit _target.md because target.md is a generated file -->