Skip to content

Commit

Permalink
Merge pull request #1 from tago-io/TCORE-258_Changes
Browse files Browse the repository at this point in the history
TCORE-258 Change the documentation
  • Loading branch information
felipefdl authored Nov 5, 2024
2 parents d2962cf + c30d501 commit 39dcb1a
Show file tree
Hide file tree
Showing 15 changed files with 2,028 additions and 1,266 deletions.
12 changes: 2 additions & 10 deletions docs/getting-started/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,6 @@ slug: /download

# Download Tagocore

To get started, head over to our [Downloads page](https://tagocore.com#download) and grab the right version for you. We offer support to all major operating systems, in the form of the following architectures:
To get started, you can either download and execute using Docker or [download the release](https://github.com/tago-io/tagocore/releases/latest) code from the Download release page and execute it.

- Alpine x64
- Alpine ARM64
- Linux x64
- Linux ARM64
- Linux ARMv7
- MacOS x64
- Windows x64

After you download TagoCore, follow the [Installation](/installation) steps.
After downloading the code, you have to follow the [Installation](/installation) steps.
16 changes: 6 additions & 10 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ slug: /installation
# Installing TagoCore

:::info
To install TagoCore, you need to [Download it](/) first.
To install TagoCore, you need to [Download it](/download) first.
:::

## Decompressing

TagoCore can be downloaded either as a compressed `tar.gz` file or a compressed `zip` file, and in both cases you need to decompress the file before using TagoCore.
TagoCore code can be downloaded either as a compressed `tar.gz` file or a compressed `zip` file, and in both cases you need to decompress the code before using TagoCore.

### .tar.gz

Expand All @@ -38,16 +38,12 @@ This command uses the `zip` command to decompress the `.zip` file in the current

## Executing TagoCore

After you decompress the downloaded file, you may execute the following command to list the files in the current directory:
After you decompress the downloaded code, you may execute the following command to execute the TagoCore:

```shell
ls
```

You should see a file named `tagocore` in there. Simply execute it:

```shell
./tagocore
just install
just build-console
just server
```

As soon as TagoCore runs, it will open a webserver and output the URL of the server in the terminal:
Expand Down
10 changes: 3 additions & 7 deletions docs/getting-started/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,10 @@ We know your time is valuable, so we'll help you understand TagoCore in 5 minute
TagoCore is a **free**, **fast**, and **open-source** IoT platform for edge computing that you can use to parse,
and analyze the data from your devices!

TagoCore supports all major operating systems, and can be downloaded in our
[Downloads page](https://tagocore.com/#download).

Once you have downloaded and extracted TagoCore, you can run it by opening a terminal in the folder
where the `tagocore` binary is located and typing the following command:
TagoCore can be downloaded and executed using Docker by typing the following command:

```shell
./tagocore
docker run -p 8888:8888 -p 8999:8999 tagoio/tagocore
```

That's it! TagoCore is up and running. ⚡
Expand Down Expand Up @@ -65,4 +61,4 @@ Check out our [Action Overview](/action) to learn more.
Plugins are extensions that allow developers to add or modify TagoCore functionalities. You can develop your own
plugin or install plugins from other developers by using the Plugin Store.

If you are interested in Plugins, you should take a look in our [Plugin Overview](/plugin) article.
If you are interested in Plugins, you should take a look in our [Plugin Overview](/plugins) article.
16 changes: 4 additions & 12 deletions docs/plugins/create/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Plugins are programs or applications created by the community and TagoIO that ex

## Prerequisites

Like TagoCore itself, Plugins are built using Node.js. You’ll need an understanding of **JavaScript** and **Node.js** to
Like TagoCore itself, Plugins are built using Node.js. You’ll need an understanding of **JavaScript** or **TypeScript** and **Node.js** to
develop plugins. You should take a look at our [Prerequisites](/plugins/create/prerequisites) before starting.

## Lifecycle
Expand All @@ -24,15 +24,7 @@ Plugins. Learn more about a [Plugin's Lifecycle](/plugin/create/lifecycle).
This tutorial will build a Plugin that allows the user to set a port for an HTTP server to start.
It will use many Plugin components to give an introductory demonstration of their relationships.

To start, you must create a new directory in TagoCore's default Plugin Folder. This folder is located in your user
profile directory. In **Windows** systems it has the name of `TagoCore`, and on **Unix-like** systems it has the
name `.tagocore`.

```bash
cd ~/.tagocore/Plugins
mkdir my-plugin
cd my-plugin
```
To begin, you need to create a new directory where your plugin will be located.

Now, we must start a new Node.js project. To do so, run the following command by opening up a terminal in the newly
created folder:
Expand All @@ -44,7 +36,7 @@ npm init --yes
### Manifest

Every Plugin needs a [manifest](/plugins/create/manifest). The Plugin manifest is defined within the package.json
of your project, so open the `package.json` file in your favorite text editor and add a `tagocore` property to it.
of your project, so open the `package.json` file in your favorite text editor and add a `tcore` property to it.

Your Plugin's `package.json` should look something like this:

Expand Down Expand Up @@ -112,7 +104,7 @@ case, we are creating a Service Module so we must add a `service` type to the ma
### Installing your Plugin

Your Plugin is ready. It doesn't do anything, but it can already be installed in TagoCore. Since you already have
created your Plugin in TagoCore's default Plugin folder, all you have to do is restart TagoCore.
created your Plugin you need to install it [Manually](/plugins/install/manually).

Once you do so, you should see something like this as soon as the application starts:

Expand Down
4 changes: 1 addition & 3 deletions docs/plugins/create/prerequisites.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,11 @@ While it is not necessary, other tools may come in handy when developing more co
these tools before starting to write plugins, but they may be useful at some point.

- [TypeScript](https://npmjs.com/package/typescript), to make navigating the API easier and write robust plugins;
- [Webpack](https://www.npmjs.com/package/webpack) or [Esbuild](https://www.npmjs.com/package/esbuild), to bundle large
multi-file projects;
- [Visual Studio Code](https://code.visualstudio.com/) as an IDE, to accelerate the development of your Plugin.

You do **not** need to have experience with front-end UI libraries such as React or Vue. TagoCore creates and manages
your Plugin's user interface via a JSON structure.

:::info Important
You should use **Node.js version 14** or greater to build plugins for TagoCore.
You should use **Node.js version 20** or greater to build plugins for TagoCore.
:::
53 changes: 0 additions & 53 deletions docs/plugins/create/publish-cli.md

This file was deleted.

27 changes: 9 additions & 18 deletions docs/plugins/install/manually.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,20 @@ slug: /plugins/install/manually

# Install Plugin Manually

Maybe you are developing a Plugin or maybe you have received a bundled plugin from someone and you want to install it manually. In either case, to install a
plugin manually you have two choices:
Maybe you are developing a Plugin or maybe you have received a plugin from someone and you want to install it manually. In either case, to install a plugin manually, you have two options:

## Install via the sidebar

TagoCore's sidebar allows you to quickly install a bundled (.tcore) plugin file. Look for the &nbsp;<img src="/img/icons/puzzle-piece.svg" width="15px"/>&nbsp; button in the sidebar and click on it.
TagoCore's sidebar allows you to quickly install a plugin by selecting its folder where the package.json file is located. Look for the &nbsp;<img src="/img/icons/puzzle-piece.svg" width="15px"/>&nbsp; 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.
:::
## Install via settings file

## Add to the Plugin Folder
To begin, you need to find the tagocore.yml file in the TagoCore folder. This folder is located in your user profile directory. On **Windows** systems, it is named `TagoCore`, while on **Unix-like** systems, it is named `.tagocore`.

If your plugin is not bundled, you need to copy the Node.js project to a subfolder in the `Plugin Folder` defined in your TagoCore's settings. After copying the project in that folder, simply restart TagoCore and your Plugin will be loaded.
In that file, there is a property named `custom_plugins`. In that property, you must enter the folder path to your plugin.

This is what the structure in the `Plugin Folder` should look like:

```
plugin_folder
- my_plugin_1
package.json
...
- my_plugin_2
package.json
...
```yml
custom_plugins:
- /path_to_your_plugin/folder_plugin_one
- /path_to_your_plugin/folder_plugin_two
```
14 changes: 8 additions & 6 deletions docs/plugins/install/pluginstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@ title: Plugin Store
slug: /plugins/install/pluginstore
---

# Install Plugin via Store
# Activate plugin via Store

To install a plugin from the Plugin Store, simply follow these steps:
All plugins in the store are inside plugins, meaning the plugin code is already included in TagoCore. Therefore, you don't need to install them, you only need to activate them.

- Click the `Plugin Store` button located in the TagoCore's sidebar.
- Select the Plugin you want to install;
- Click on `Install` in the right side of the page to install the Plugin.
To activate a plugin from the Plugin Store, simply follow these steps:

- Click the `Store` button located in the TagoCore's sidebar.
- Select the Plugin you want to activate;
- Click on `Activate` in the right side of the page to activate the Plugin.

:::info Good to know
You won't be able to install a Plugin that is not compatible with your Platform.
You won't be able to activate a Plugin that is not compatible with your Platform.
:::
2 changes: 1 addition & 1 deletion docs/plugins/introduction.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_position: 1
title: Overview
slug: /plugin
slug: /plugins
---

# Plugins
Expand Down
Loading

0 comments on commit 39dcb1a

Please sign in to comment.