Updating docs

docs/docs/getting-started/_category_.json → docs/docs/examples/_category_.json

@@ -1,6 +1,6 @@
 {
-  "label": "Getting Started",
-  "position": 4,
+  "label": "Examples",
+  "position": 5,
   "link": {
     "type": "generated-index",
     "description": "There are two ways of creating digital twins, the first is using the Eclipse Ditto API and the second is using our Grafana plugin(WIP). \n It is recommended using Postman to make all requests but youy can use your own method."

docs/docs/guides/_category_.json

@@ -1,6 +1,6 @@
 {
-    "label": "Advanced guides",
-    "position": 5,
+    "label": "Guides",
+    "position": 4,
     "link": {
       "type": "generated-index"
     }

docs/docs/installation/using-helm.md

@@ -2,7 +2,7 @@
 sidebar_position: 1
 ---
 
-# Installation using Helm
+# Helm
 
 ## Requirements
 
@@ -14,24 +14,25 @@ sidebar_position: 1
 
 
 ## Installation
-First of all, you have to add Ertis Research group helm repository to your helm repository list:
+First of all, you have to add ERTIS Research group helm repository to your helm repository list:
+
 ```bash
 helm repo add ertis https://ertis-research.github.io/Helm-charts/
 ```
 
-Once done, the next step is installing the chart by executing this line on your terminal (in our case, we will use `ot` as release name and `digitaltwins` as namespace, but you can choose the one that you prefeer):
+Once done, the next step is installing the chart by executing this line on your terminal (in our case, we will use `opentwins` as release name and `opentwins` as namespace, but you can choose the one that you prefeer). To customize the installation, please refer to [Helm's values](https://github.com/ertis-research/Helm-charts/blob/main/OpenTwins/values.yaml) file.
 
 ```bash
-helm install ot ertis/OpenTwins -n digitaltwins
+helm upgrade --install opentwins ertis/OpenTwins -n opentwins --wait --dependency-update
 ```
 
-After waiting some time, the installation is done, but you still need to configure several conections (we are working on making it automatic) as described on the [wiki](https://ertis-research.github.io/digital-twins-platform/).
+After waiting some time, the installation will be ready for use.
 
 
 ## Lightweight installation
 As described in the main page, OpenTwins has it's own lightweight version that aims to run on IoT devices such as Raspberry Pi devices.
-To install this versión, you have to follow the first step in order to add Ertis repository to your repository list and then install the platform using the command bellow:
+To install this versión, you have to follow the first step in order to add ERTIS repository to your repository list and then install the platform using the command bellow:
 ```bash
-helm install ot ertis/OpenTwins-Lightweight -n digitaltwins
+helm install ot ertis/OpenTwins-Lightweight -n opentwins
 ``` 
-As the previous case, some connections still need to be made for the platform to work properly.
+In this case connections still need to be made for the platform to work properly.

docs/docs/overview/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Overview",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "There are two ways of installation, you can use helm, the easiest way of deployment or you can install every single component manually."
+  }
+}

docs/docs/architecture.md → docs/docs/overview/architecture.md

@@ -6,7 +6,7 @@ sidebar_position: 2
 
 This platform is built around the [Eclipse Ditto](https://www.eclipse.org/ditto/) digital twin framework. The following image shows the current architecture of the platform, which is intended to be extended over time. Each of the colours represents components that serve a certain functionality. These components are mostly external projects to our organisation, although there are also certain components that have had to be created especially for the platform. The code and documentation for these can be found in their respective repositories, which are all linked in the [components folder](https://github.com/ertis-research/digital-twins-platform/tree/main/components).
 
-![Architecture](img/architecture.jpg)
+![Architecture](../img/architecture.jpg)
 
 - The **blue part** represents the base of the platform, as it is made up of components that cover the **basic functionality** of any digital twin platform. It is composed of the following components:
   - [Eclipse Ditto](https://www.eclipse.org/ditto/).

docs/docs/overview/concepts.md

@@ -0,0 +1,13 @@
+---
+sidebar_position: 3
+---
+
+# Concepts
+
+This platform has been designed to facilitate the development of digital twins and is characterised by the exclusive use of open source components. The aim is to achieve a platform that covers all the functionalities that a digital twin may require, from the most basic ones, such as simply checking its real-time state, to more advanced ones, such as the inclusion of predicted or simulated data or visualisation of 3D models of the twins.
+
+:::danger Take care
+
+This platform is currently under development, so its use in production environments is not recommended at this stage.
+
+:::

docs/docs/intro.md → docs/docs/overview/purpose.md

@@ -2,7 +2,7 @@
 sidebar_position: 1
 ---
 
-# Introduction
+# Purpose
 
 This platform has been designed to facilitate the development of digital twins and is characterised by the exclusive use of open source components. The aim is to achieve a platform that covers all the functionalities that a digital twin may require, from the most basic ones, such as simply checking its real-time state, to more advanced ones, such as the inclusion of predicted or simulated data or visualisation of 3D models of the twins.
 
@@ -11,4 +11,3 @@ This platform has been designed to facilitate the development of digital twins a
 This platform is currently under development, so its use in production environments is not recommended at this stage.
 
 :::
-

docs/docs/quickstart.md

@@ -0,0 +1,49 @@
+---
+sidebar_position: 1
+---
+
+# Quickstart
+
+Welcome to OpenTwins, a flexible platform adapted to your needs! Although OpenTwins offers extensive customization options, we understand the importance of simplicity for beginners. Therefore, let's embark on a short journey together, showing you the quickest route to deploy the platform and develop a simple, functional digital twin.
+
+## Prerequisites
+Please be sure you have the following utilities installed on your host machine:
+
+- [Docker](https://www.docker.com/)
+- [Kubernetes](https://kubernetes.io/releases/download/)
+- [Helm](https://helm.sh/docs/intro/install/) v3
+
+If you don't have a Kubernetes cluster, you can set one up on local using [minikube](https://minikube.sigs.k8s.io/docs/). For a smooth deployment experience, we suggest you use the following minimum configuration values.
+
+```bash
+minikube start --cpus 4 --disk-size 40gb --memory 8192
+```
+```bash
+kubectl config use-context minikube
+```
+
+## Installation
+The quickest way to deploy OpenTwins is [using Helm](https://helm.sh/docs/intro/using_helm/).
+
+The following command adds the ERTIS repository where the OpenTwins helm chart is located.
+
+```bash
+helm repo add ertis https://ertis-research.github.io/Helm-charts/
+```
+
+To deploy the platform with recommended functionality, use the command below:
+
+```bash
+helm upgrade --install opentwins ertis/OpenTwins -n opentwins --wait --dependency-update
+```
+
+To modify the components to be deployed and connected during the installation, you can check the [installation via Helm](./installation/using-helm.md).
+
+
+## Define your first digital twin
+
+A digital twin is composed of static and dynamic information.
+
+## Link the digital twin to a data input
+
+## Visualize twin data

docs/docusaurus.config.js

@@ -65,7 +65,7 @@ const config = {
         items: [
           {
             type: 'doc',
-            docId: 'intro',
+            docId: 'quickstart',
             position: 'left',
             label: 'Documentation',
           },

docs/src/components/Homepage/customNavbar.tsx

@@ -13,7 +13,7 @@ export default function CustomNavbar(): JSX.Element {
                 <Link
                     style={{ fontWeight: 'bold', fontFamily: 'RobotoMono' }}
                     className='margin-right--lg'
-                    to="/docs/intro">
+                    to="/docs/quickstart">
                     documentation
                 </Link>
                 <Link

docs/src/components/Homepage/mainPart.tsx

@@ -32,7 +32,7 @@ export default function CustomNavbar(): JSX.Element {
                         <div className='center-content margin-top--lg margin-bottom--md'>
                             <Link
                                 className="button button--primary button--lg"
-                                to="/docs/intro">
+                                to="/docs/quickstart">
                                 Get started
                             </Link>
                             <Link

docs/src/pages/index.tsx

@@ -19,7 +19,7 @@ function HomepageHeader() {
         <div className={styles.buttons}>
           <Link
             className="button button--secondary button--lg"
-            to="/docs/intro">
+            to="/docs/quickstart">
             Introduction
           </Link>
         </div>