Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 18
node-version: 20
cache-dependency-path: docs/yarn.lock
cache: yarn

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 18
node-version: 20
cache-dependency-path: docs/yarn.lock
cache: yarn

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@ When you first start the client, you will see the status as `initializing.` To l
Initially, the profile will be set to `Default` — review the next section to learn how to create your own profile.

![Client 002](/img/client-configuration/v2-client-config-002.png)

14 changes: 10 additions & 4 deletions docs/docs/v2/gettingStarted/clientConfiguration/030-usingDelays.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,19 @@ description: "How to use Delays"
---

# Using Delays

Delays are a helpful way to organize your processes and add `delay` to their startup.
Delays are a helpful way to postpone the start of an application. For instance, if we need our `TouchDesigner_Data` processes to start 10 seconds after sudoSignals launches, we can use a `delay`.

![Client Profile Process 004](/img/client-configuration/v2-client-profile-process-004.png)

## Adding Delays

On Configuration tab, the Processes column has a button to `Add Delay`.
We can add a delay by pressing the `Add Delay` button in the Processes column.

![Client Profile Process 004A](/img/client-configuration/v2-client-profile-process-004A.png)

### Adjusting Delays

By default, delays are set to `5 seconds`. Click on the clock icon to adjust the duration of the delay.
By default, delays are set to `0.5 seconds`. Click on the clock icon to adjust the duration of the delay.

![Client Profile Process 005](/img/client-configuration/v2-client-profile-process-005.png)

Expand All @@ -30,3 +29,10 @@ A dialog will appear where you can adjust the duration (in seconds).
The placement of the delay can also be adjusted by using the handle icon (left) of the delay card.

![Client Profile Process 005B](/img/client-configuration/v2-client-profile-process-005B.png)

![Client Profile Process 005C](/img/client-configuration/v2-client-profile-process-005C.png)

## Multiple Processes
Delays are also a great way to organize multiple processes. Without delays, sudoSignals will launch all applications on start at the same time. With delays, we can organize our processes to start in a specific order and cadence.

![Client Profile Process 005D](/img/client-configuration/v2-client-profile-process-005D.png)
18 changes: 12 additions & 6 deletions docs/docs/v2/gettingStarted/clientConfiguration/040-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,23 @@ The sudoSignals client has addional settings for specifying directories, resetti

![Client Settings 01](/img/client-configuration/v2-client-settings-001.png)

## Port Number
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
### Port Number
The port that is used for operational communication between processes.

## Profile Directory
### Profile Directory
The directory location for the client's profiles.

## Log Directory
### Log Directory
The directory location for the client's log files.

## Resetting Defaults
### Resetting Defaults
Pressing the `Reset Defaults` button will reset any changes made on the Settings page.

## Revoking Access
### Revoking Access
Pressing the `Revoke Access` button will revoke the dashboard's access to the client. It will also generate a new token for the Client.

### Save & Quit

In order to apply changes in Settings, sudoSignals must save and quit. Please reopen the application to view any changes you may have applied.

![Client Settings 01](/img/client-configuration/v2-client-settings-002.png)
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Client Configuration
sidebar_position: 30
slug: /v2/getting-started/client-configuration
sidebar_position: 3
slug: /v2/getting-started/client-configuration/
description: "A step-by-step guide through creating your first installation"

---

import DocCardList from '@theme/DocCardList';

# Client Configuration
Expand All @@ -19,4 +19,3 @@ sudoSignals runs as a local process on your Windows computer, and is controlled
---
<DocCardList />

<!-- links -->
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Configure a Process
slug: /v2/getting-started/client-configuration/configure-a-process
sidebar_position: 30
sidebar_position: 25
description: "Configuring your Processes"
---

Expand Down
10 changes: 5 additions & 5 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "^3.7.0",
"@docusaurus/preset-classic": "^3.7.0",
"@docusaurus/core": "^3.9.2",
"@docusaurus/preset-classic": "^3.9.2",
"@mdx-js/react": "^3.0.0",
"clsx": "^2.0.0",
"docusaurus-lunr-search": "^3.6.0",
Expand All @@ -24,8 +24,8 @@
"react-dom": "^19.0.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.7.0",
"@docusaurus/types": "^3.7.0"
"@docusaurus/module-type-aliases": "^3.9.2",
"@docusaurus/types": "^3.9.2"
},
"browserslist": {
"production": [
Expand All @@ -42,4 +42,4 @@
"engines": {
"node": ">=18.0"
}
}
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading