From e6374df5ecd2f5ce2102d829e2b2580c9dca87b5 Mon Sep 17 00:00:00 2001 From: Felipe Lima Date: Tue, 15 Oct 2024 11:33:25 -0400 Subject: [PATCH] fixed links --- docs/getting-started/download.md | 2 +- docs/plugins/create/getting-started.md | 2 +- docs/plugins/create/lifecycle.md | 2 +- docs/plugins/install/manually.md | 2 +- docs/resources/action/overview.md | 4 ++-- docs/resources/action/trigger.md | 2 +- docs/resources/analysis/console.md | 4 ++-- docs/resources/analysis/overview.md | 6 +++--- docs/resources/bucket/overview.md | 4 ++-- docs/resources/device/live-inspector.md | 4 ++-- docs/resources/device/overview.md | 2 +- docs/resources/log.md | 2 +- docs/resources/settings.md | 2 +- 13 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/getting-started/download.md b/docs/getting-started/download.md index bc1bef6..778a58a 100644 --- a/docs/getting-started/download.md +++ b/docs/getting-started/download.md @@ -16,4 +16,4 @@ To get started, head over to our [Downloads page](https://tagocore.com#download) - MacOS x64 - Windows x64 -After you download TagoCore, follow the [Installation](/docs/installation) steps. +After you download TagoCore, follow the [Installation](/installation) steps. diff --git a/docs/plugins/create/getting-started.md b/docs/plugins/create/getting-started.md index e2ed608..5c34691 100644 --- a/docs/plugins/create/getting-started.md +++ b/docs/plugins/create/getting-started.md @@ -116,7 +116,7 @@ created your Plugin in TagoCore's default Plugin folder, all you have to do is r Once you do so, you should see something like this as soon as the application starts: - + ### Give users options diff --git a/docs/plugins/create/lifecycle.md b/docs/plugins/create/lifecycle.md index 047fe58..6efcc8d 100644 --- a/docs/plugins/create/lifecycle.md +++ b/docs/plugins/create/lifecycle.md @@ -83,7 +83,7 @@ the plugin will still be loaded normally and its state will still be `started`. However, the Module will have its state as `stopped` and the error will appear in the `Plugin Configuration` page of your Plugin, under your Module's status: - + This functionality is a great tool for you to indicate that something is not quite right in your Plugin, or that some unexpected error happened while trying to start/stop your Module. diff --git a/docs/plugins/install/manually.md b/docs/plugins/install/manually.md index cdda4b8..4d77987 100644 --- a/docs/plugins/install/manually.md +++ b/docs/plugins/install/manually.md @@ -11,7 +11,7 @@ plugin manually you have two choices: ## Install via the sidebar -TagoCore's sidebar allows you to quickly install a bundled (.tcore) plugin file. Look for the    button in the sidebar and click on it. +TagoCore's sidebar allows you to quickly install a bundled (.tcore) plugin file. Look for the    button in the sidebar and click on it. :::info This option is designed to load bundled (.tcore) files. If you have a simple Node.js project, go to the next option. diff --git a/docs/resources/action/overview.md b/docs/resources/action/overview.md index 79b9832..9a5b8c0 100644 --- a/docs/resources/action/overview.md +++ b/docs/resources/action/overview.md @@ -18,8 +18,8 @@ With Actions you can: ## Adding an Action -To add a new Action, press the   button on the **Actions** page. Once you press the button, the **Add Action** modal will appear for you to insert a new action: +To add a new Action, press the   button on the **Actions** page. Once you press the button, the **Add Action** modal will appear for you to insert a new action: - + In this modal, you must define a name, a [trigger](/action/trigger), and a [type](/action/type). diff --git a/docs/resources/action/trigger.md b/docs/resources/action/trigger.md index 6db9ace..a3687fb 100644 --- a/docs/resources/action/trigger.md +++ b/docs/resources/action/trigger.md @@ -23,7 +23,7 @@ There are 2 (two) categories inside of this trigger type: ### Trigger Conditions After setting up the [Device](/device), you should set a condition for your Action to be executed. - + 1. **Select a variable** to be tested. This will be one of the variables that will be compared against the data from the device. 2. **Define the type** of condition to test the variable. The available test conditions are: diff --git a/docs/resources/analysis/console.md b/docs/resources/analysis/console.md index fe0fc27..5272bb9 100644 --- a/docs/resources/analysis/console.md +++ b/docs/resources/analysis/console.md @@ -27,14 +27,14 @@ If something goes wrong during this validation process, an error will be logged ## Clearing logs -If you ever feel like there is too much information in your Console, feel free to click the    button to hide all the logs and make room for new ones. +If you ever feel like there is too much information in your Console, feel free to click the    button to hide all the logs and make room for new ones. Clearing logs is a temporary measure, all the logs will be back if you leave the Analysis' page and come back. ## Downloading logs -TagoCore offers the possibility to download the logs of your Analysis by clicking the    button located in the Console header. The logs will be downloaded as a **.txt** file. +TagoCore offers the possibility to download the logs of your Analysis by clicking the    button located in the Console header. The logs will be downloaded as a **.txt** file. :::info Only the logs currently visible on the screen will be downloaded. If you clear the logs before downloading, the log file will be empty. diff --git a/docs/resources/analysis/overview.md b/docs/resources/analysis/overview.md index f2f2927..f713780 100644 --- a/docs/resources/analysis/overview.md +++ b/docs/resources/analysis/overview.md @@ -11,9 +11,9 @@ Analysis is a powerful feature that experts and developers can use to implement ## Adding an Analysis -To add a new Analysis, press the   button on the **Analyses** page. Once you press the button, the **Add Analysis** modal will appear for you to insert a new Analysis: +To add a new Analysis, press the   button on the **Analyses** page. Once you press the button, the **Add Analysis** modal will appear for you to insert a new Analysis: - + In this modal, you must define a name for your Analysis in order to continue. @@ -44,7 +44,7 @@ The File path field allows you to select a file that will be passed as a command Let's pretend you want to run code in Node.js. To achieve this, you could install [nvm](https://github.com/nvm-sh/nvm) in your local machine and then use the `node` executable provided by nvm in the **Binary executable path** field. After this, you may select a file in the **File path** field, like so: - + Under the hood, TagoCore would use the following terminal command to run your analysis: diff --git a/docs/resources/bucket/overview.md b/docs/resources/bucket/overview.md index 72b9253..3db06b9 100644 --- a/docs/resources/bucket/overview.md +++ b/docs/resources/bucket/overview.md @@ -14,8 +14,8 @@ When a [Device](/device) is created, TagoCore automatically creates a Bucket for ## Adding a Bucket -To add a new Bucket, press the   button on the **Buckets** page. Once you press the button, the **Add Bucket** modal will appear for you to insert a new bucket: +To add a new Bucket, press the   button on the **Buckets** page. Once you press the button, the **Add Bucket** modal will appear for you to insert a new bucket: - + In this modal, you must define a name and you can optionally define a [data retention](/bucket/data-retention) period for the [data](/bucket/data) in your Bucket. diff --git a/docs/resources/device/live-inspector.md b/docs/resources/device/live-inspector.md index 40a2a98..8127ff5 100644 --- a/docs/resources/device/live-inspector.md +++ b/docs/resources/device/live-inspector.md @@ -10,7 +10,7 @@ Live Inspector is a useful tool for developers to debug [Payload Parser scripts] ## How to activate it -To activate the Live Inspector of a Device, click the   button. +To activate the Live Inspector of a Device, click the   button. While the Live Inspector is active, all traffic related to the Device will be monitored in real time and each package sent will be recorded and displayed on the screen. @@ -20,4 +20,4 @@ The Live Inspector will only stay activated while the Device page is open. It wi ## How to deactivate it -To deactivate the Live Inspector of a Device, click the   button. +To deactivate the Live Inspector of a Device, click the   button. diff --git a/docs/resources/device/overview.md b/docs/resources/device/overview.md index 707c658..342b29f 100644 --- a/docs/resources/device/overview.md +++ b/docs/resources/device/overview.md @@ -12,7 +12,7 @@ The default communication between external devices and TagoCore is done through ## Adding a Device -To add a new device, press the   button on the **Devices** page. Once you press the button, a new Device will automatically be created with the name **New Device**. +To add a new device, press the   button on the **Devices** page. Once you press the button, a new Device will automatically be created with the name **New Device**. :::info When a Device is created, TagoCore automatically creates a [Bucket](/bucket) for it with the same name. diff --git a/docs/resources/log.md b/docs/resources/log.md index b0e9e90..535d304 100644 --- a/docs/resources/log.md +++ b/docs/resources/log.md @@ -8,7 +8,7 @@ slug: /log Application Logs allow you to visualize the logs of the application and plugins. -To access this page, click on the    button located on the upper right-hand corner of the screen. +To access this page, click on the    button located on the upper right-hand corner of the screen. ## Channel diff --git a/docs/resources/settings.md b/docs/resources/settings.md index 6b32b8a..a6f6b08 100644 --- a/docs/resources/settings.md +++ b/docs/resources/settings.md @@ -6,7 +6,7 @@ slug: /settings # Settings -The settings page allows you to modify any configuration related to TagoCore. You can visit this page by clicking on the    button on the sidebar. +The settings page allows you to modify any configuration related to TagoCore. You can visit this page by clicking on the    button on the sidebar. Settings are saved to a `.yml` file located in the `tagocore` folder, which resides in your Operating System's `Home Directory`.