diff --git a/docs/docs/v2/dashboardAnatomy/installationView/030-reports.md b/docs/docs/v2/dashboardAnatomy/installationView/030-reports.md index e5737ad..2b240bb 100644 --- a/docs/docs/v2/dashboardAnatomy/installationView/030-reports.md +++ b/docs/docs/v2/dashboardAnatomy/installationView/030-reports.md @@ -1,7 +1,7 @@ --- title: Reports slug: /v2/getting-started/view-installations/reports -description: "An overview of the Logs on the Dashboard" +description: "An overview of the Reports on the Dashboard" --- # Reports diff --git a/docs/docs/v2/gettingStarted/clientConfiguration/configureAProcess/010-advancedOptions.md b/docs/docs/v2/gettingStarted/clientConfiguration/configureAProcess/010-advancedOptions.md index e308955..1748338 100644 --- a/docs/docs/v2/gettingStarted/clientConfiguration/configureAProcess/010-advancedOptions.md +++ b/docs/docs/v2/gettingStarted/clientConfiguration/configureAProcess/010-advancedOptions.md @@ -16,13 +16,7 @@ Advanced process options are optional and not required for sudoSignals to monito ::: -## Working Directory File - -:::danger COPY NEEDED - -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. - -::: +## Working Directory File ## Command Line Preview @@ -32,12 +26,6 @@ The Preview Command Line field displays the equivalent command string that will ### Command Line Arguments -:::danger COPY NEEDED - -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. - -::: - ![Client Profile Process 003B](/img/client-configuration/v2-client-profile-process-003B.png) diff --git a/docs/docs/v2/gettingStarted/clientConfiguration/configureAProcess/configureAProcess.mdx b/docs/docs/v2/gettingStarted/clientConfiguration/configureAProcess/configureAProcess.mdx index c2fc4c8..1724e85 100644 --- a/docs/docs/v2/gettingStarted/clientConfiguration/configureAProcess/configureAProcess.mdx +++ b/docs/docs/v2/gettingStarted/clientConfiguration/configureAProcess/configureAProcess.mdx @@ -44,9 +44,9 @@ If you'd like to specify that sudoSignals open an application or file, toggle th ### Uses Plugin -:::danger COPY NEEDED +:::caution IN PROGRESS -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. +This feature is still in progress for v2 release. ::: diff --git a/docs/docs/v2/gettingStarted/gettingStarted.mdx b/docs/docs/v2/gettingStarted/gettingStarted.mdx index 6fdc762..9ba49a3 100644 --- a/docs/docs/v2/gettingStarted/gettingStarted.mdx +++ b/docs/docs/v2/gettingStarted/gettingStarted.mdx @@ -11,9 +11,9 @@ import DocCardList from '@theme/DocCardList'; sudoSignals is an application monitor that's connected to a web dashboard. -:::danger +:::caution IN PROGRESS -REPLACE VIDEO +This video is still getting updated for Beta Early Access. ::: diff --git a/docs/docs/v2/plugins/TouchDesigner/010-gettingStartedTD.md b/docs/docs/v2/plugins/TouchDesigner/010-gettingStartedTD.md index b945c3b..f38c2ca 100644 --- a/docs/docs/v2/plugins/TouchDesigner/010-gettingStartedTD.md +++ b/docs/docs/v2/plugins/TouchDesigner/010-gettingStartedTD.md @@ -19,35 +19,11 @@ The Signals plugin can be downloaded from the [GitHub page](https://github.com/S Configure sudoSignals to open your project file. If you don't have a project handy, you can set sudoSignals open blank TouchDesigner project. If you need a quick reminder about how to configure sudoSignals to open a process, review the [Configure a Process](/v2/getting-started/client-configuration/configure-a-process) page. -## Launch your TouchDesigner Process with sudoSignals - -:::danger Question - -IS THIS STILL A THING? - -::: - -Make sure Signals has launched your process. On the dashboard, you should see that there is now a process with the message: - -``` -This process has not connected yet and has limited information available -``` - -That tells us that sudoSignals has started our process, but that our process is not yet directly communicating back to the dashboard. - -![TD Plugin 002](/img/td-remote-setup/remote-setup-002.png) - ## Add the sudoSignals TOX -:::danger UPDATE - -NEED NEW SCREENSHOT - -::: - Next, drop the sudoSignals TOX you downloaded into your project. -![TD Plugin 003](/img/td-remote-setup/remote-setup-003.png) +![TD Plugin 003](/img/td-remote-setup/v2-remote-setup-003.png) After dropping the plugin into TouchDesigner you should see some additional information on your dashboard. Your process button should change from red to green, and we should now see controls that are available from our TouchDesigner process. @@ -80,13 +56,7 @@ To set your own controls, simply drag and drop an operator with custom parameter ::: -:::danger UPDATE - -NEED NEW SCREENSHOT - -::: - -![TD Plugin 006](/img/td-remote-setup/remote-setup-006.png) +![TD Plugin 006](/img/td-remote-setup/v2-remote-setup-006.png) You should see that these same parameters and page names are reflected on the Dashboard: @@ -115,13 +85,7 @@ Currently only numerical values are supported by the graphing tool kit in use. T ::: -:::danger UPDATE - -NEED NEW SCREENSHOT - -::: - -![TD Plugin 008](/img/td-remote-setup/remote-setup-008.png) +![TD Plugin 008](/img/td-remote-setup/v2-remote-setup-008.png) KPIs are sent to the Signals service at a regular interval — these are then forwarded to the cloud. These reports can be seen in the graphs section of the Installation view by selecting the `Process` option from the drop down menu. @@ -131,13 +95,7 @@ In addition to reports, the TouchDesigner sudoSignals plugin has an example conf A default operator with custom reports is provided to help you get started. -:::danger UPDATE - -NEED NEW SCREENSHOT - -::: - -![TD Plugin 009](/img/td-remote-setup/remote-setup-009.png) +![TD Plugin 009](/img/td-remote-setup/v2-remote-setup-009.png) Log messages from your process can be found on the logs tab in the dashboard. diff --git a/docs/docs/v2/plugins/TouchDesigner/020-manualConfigTD.md b/docs/docs/v2/plugins/TouchDesigner/020-manualConfigTD.md index 60dbbc6..8f49327 100644 --- a/docs/docs/v2/plugins/TouchDesigner/020-manualConfigTD.md +++ b/docs/docs/v2/plugins/TouchDesigner/020-manualConfigTD.md @@ -8,17 +8,11 @@ description: "Manually configuring the TouchDesigner plugin" In some instances you may want to manually configure your the sudoSignals TouchDesigner plugin. For example, if sudoSignals is running in an [Engine COMP](https://derivative.ca/UserGuide/Engine_COMP), or as an embedded component inside another system. In those cases you way want sudoSignals to report out machine stats, or provide some handles for control without using sudoSignals to start the process itself. -## Client Configuration +## Process Configuration -Configuring the sudoSignals client is an important first step in the manual configuration process. On the configuration page take note of your `Process ID` this will be an essential identifier when setting-up the TouchDesigner Plugin to work with Signals. +Configuring the sudoSignals client is an important first step in the manual configuration process. On the Configure Process page take note of your `Process ID` this will be an essential identifier when setting-up the TouchDesigner Plugin to work with Signals. -:::danger Question - -IS THIS STILL A THING? - -::: - -![Create Account 002](/img/td-manual-config/td-manual-config-01.png) +![Create Account 002](/img/td-manual-config/v2-td-manual-config-01.png) :::info @@ -30,19 +24,13 @@ For manual plugin configurations, the `Auto Start` parameter should be toggled o Drag and drop the `sudoSignals` TOX into your network. -:::danger UPDATE - -NEW SCREENSHOT - -::: - -![Create Account 002](/img/td-manual-config/td-manual-config-02.png) +![Create Account 002](/img/td-manual-config/v2-td-manual-config-02.png) On the `Advanced Settings` page toggle on the `Manual Configuration` parameter: -![Create Account 002](/img/td-manual-config/td-manual-config-03.png) +![Create Account 002](/img/td-manual-config/v2-td-manual-config-03.png) -With `Manual Configuration` toggled on, head back to the `Settings` page. On the settings page enter the `Process ID` from the `Client Configuration` page. +With `Manual Configuration` toggled on, head back to the `Settings` page. On the settings page enter the `Process ID` from the `Configure Process` page. Next head back to the `Advanced Settings` page and click on `Reset Connection` to restart the connection between TouchDesigner and sudoSignals. diff --git a/docs/docs/v2/plugins/TouchDesigner/TouchDesigner.mdx b/docs/docs/v2/plugins/TouchDesigner/TouchDesigner.mdx index 3cc814c..6fe4e33 100644 --- a/docs/docs/v2/plugins/TouchDesigner/TouchDesigner.mdx +++ b/docs/docs/v2/plugins/TouchDesigner/TouchDesigner.mdx @@ -12,9 +12,9 @@ Getting started with remote control for a TouchDesigner project is easy. Before we look at configuring our TouchDesigner project, first make sure that you have followed all of the instructions for getting your sudoSignals client installed and configured. -:::danger +:::caution IN PROGRESS -REPLACE VIDEO +This video is still getting updated for Beta Early Access. ::: @@ -22,6 +22,7 @@ REPLACE VIDEO + TouchDesigner is a visual development platform that equips you with the tools you need to create stunning realtime projects and rich user experiences. Whether you're creating interactive media systems, architectural projections, live music visuals, or simply rapid-prototyping your latest creative impulse, TouchDesigner is the platform that can do it all. You can learn more about TouchDesigner here — [TouchDesigner] :::caution TouchDesigner Version diff --git a/docs/docs/v2/plugins/nodeJS/010-gettingStartedNode.md b/docs/docs/v2/plugins/nodeJS/010-gettingStartedNode.md index 7a1505c..bbd5b62 100644 --- a/docs/docs/v2/plugins/nodeJS/010-gettingStartedNode.md +++ b/docs/docs/v2/plugins/nodeJS/010-gettingStartedNode.md @@ -5,6 +5,13 @@ description: "An overview of NodeJS for sudoSignals" --- # Getting Started + +:::caution IN PROGRESS + +This plugin is still in development during Beta Early Access. + +::: + To install NodeJS and learn more about developing NodeJS apps check out [https://nodejs.dev/learn](https://nodejs.dev/learn) diff --git a/docs/docs/v2/plugins/nodeJS/020-remoteControlNode.md b/docs/docs/v2/plugins/nodeJS/020-remoteControlNode.md index 283066e..3ed4c0a 100644 --- a/docs/docs/v2/plugins/nodeJS/020-remoteControlNode.md +++ b/docs/docs/v2/plugins/nodeJS/020-remoteControlNode.md @@ -5,6 +5,13 @@ description: "To unlock more advanced features of sudoSignals in a NodeJS app we --- # Logging, Reporting, and Controls + +:::caution IN PROGRESS + +This plugin is still in development during Beta Early Access. + +::: + To unlock more advanced features of sudoSignals in a NodeJS app we have to add a few more elements. ## 1. Creating Logs diff --git a/docs/docs/v2/plugins/nodeJS/nodeJS.mdx b/docs/docs/v2/plugins/nodeJS/nodeJS.mdx index 384c9a5..15041d1 100644 --- a/docs/docs/v2/plugins/nodeJS/nodeJS.mdx +++ b/docs/docs/v2/plugins/nodeJS/nodeJS.mdx @@ -8,6 +8,12 @@ import DocCardList from '@theme/DocCardList'; # NodeJS +:::caution IN PROGRESS + +This plugin is still in development during Beta Early Access. + +::: + This plugin operates by communicating to the sudoSignals local service installed on your machine. For more information on how to install check out the [getting started instructions.](https://docs.sudosignals.com/docs/gettingStarted/installSignals/) To getting started using NodeJS and learn more about developing NodeJS apps check out [https://nodejs.dev/learn](https://nodejs.dev/learn) diff --git a/docs/docs/v2/remoteControl/010-machineControls.md b/docs/docs/v2/remoteControl/010-machineControls.md index 5db3d5c..6ae5121 100644 --- a/docs/docs/v2/remoteControl/010-machineControls.md +++ b/docs/docs/v2/remoteControl/010-machineControls.md @@ -12,5 +12,3 @@ Machine controls can be accessed by using one of the [SudoMagic developed plugin ![Controls 001](/img/controls/v2-machine-controls-001.png) The TouchDesigner plugin, for example, lets you quickly mirror your controls from your TouchDesigner project in a web friendly format. Control schemas are pre-defined, and allow for your development team to focus on building compelling experiences rather than creating overly complex dashboard controls. - -![Controls 002](/img/controls/v2-machine-controls-002.png) diff --git a/docs/static/img/td-manual-config/v2-td-manual-config-01.png b/docs/static/img/td-manual-config/v2-td-manual-config-01.png new file mode 100644 index 0000000..b3cd31b Binary files /dev/null and b/docs/static/img/td-manual-config/v2-td-manual-config-01.png differ diff --git a/docs/static/img/td-manual-config/v2-td-manual-config-02.png b/docs/static/img/td-manual-config/v2-td-manual-config-02.png new file mode 100644 index 0000000..ba05805 Binary files /dev/null and b/docs/static/img/td-manual-config/v2-td-manual-config-02.png differ diff --git a/docs/static/img/td-manual-config/v2-td-manual-config-03.png b/docs/static/img/td-manual-config/v2-td-manual-config-03.png new file mode 100644 index 0000000..9eaeaaf Binary files /dev/null and b/docs/static/img/td-manual-config/v2-td-manual-config-03.png differ diff --git a/docs/static/img/td-remote-setup/v2-remote-setup-003.png b/docs/static/img/td-remote-setup/v2-remote-setup-003.png new file mode 100644 index 0000000..ba05805 Binary files /dev/null and b/docs/static/img/td-remote-setup/v2-remote-setup-003.png differ diff --git a/docs/static/img/td-remote-setup/v2-remote-setup-006.png b/docs/static/img/td-remote-setup/v2-remote-setup-006.png new file mode 100644 index 0000000..22b9afe Binary files /dev/null and b/docs/static/img/td-remote-setup/v2-remote-setup-006.png differ diff --git a/docs/static/img/td-remote-setup/v2-remote-setup-008.png b/docs/static/img/td-remote-setup/v2-remote-setup-008.png new file mode 100644 index 0000000..c2cf60d Binary files /dev/null and b/docs/static/img/td-remote-setup/v2-remote-setup-008.png differ diff --git a/docs/static/img/td-remote-setup/v2-remote-setup-009.png b/docs/static/img/td-remote-setup/v2-remote-setup-009.png new file mode 100644 index 0000000..48b5d47 Binary files /dev/null and b/docs/static/img/td-remote-setup/v2-remote-setup-009.png differ