diff --git a/README.md b/README.md
index ece9263..9f24619 100644
--- a/README.md
+++ b/README.md
@@ -9,464 +9,4 @@ You can find more information about OpenTwins and its architecture in the [publi
This platform is currently **under development**, so its use in production environments is not recommended at this stage.
But you can visit the wiki here
-[https://github.com/ertis-research/OpenTwins](https://ertis-research.github.io/OpenTwins/)
-
-## Table of Contents
-- [Changelog](#changelog)
-- [Architecture](#architecture)
-- [Deploy platform in a fast way](#deploy-platform-in-a-fast-way)
- - [Requirements to deploy using Helm](#requirements-to-deploy-using-helm)
- - [Steps to deploy platform using Helm](#steps-to-deploy-platform-using-helm)
-- [Deploy platform manually](#deploy-platform-manually)
- - [Requirements to deploy manually](#requirements-to-deploy-manually)
- - [Steps to deploy platform manually](#steps-to-deploy-platform-manually)
- - [Deploying Eclipse Ditto and Eclipse Hono](#deploying-eclipse-ditto-and-eclipse-hono)
- - [Deploying Apache Kafka](#deploying-apache-kafka)
- - [Deploying InfluxDB](#deploying-influxdb)
- - [Deploying Grafana](#deploying-grafana)
- - [Connecting Eclipse Hono and Eclipse Ditto](#connecting-eclipse-hono-and-eclipse-ditto)
- - [Connecting Eclipse Ditto and Kafka](#connecting-eclipse-ditto-and-kafka)
- - [Connecting Kafka and InfluxDB: Deploying Telegraf](#connecting-kafka-and-influxdb-deploying-telegraf)
- - [Connecting InfluxDB and Grafana](connecting-influxdb-and-grafana)
- - [Deploying Extended API for Eclipse Ditto](#deploying-extended-api-for-eclipse-ditto)
- - [Installing Digital Twins plugin for Grafana](#installing-digital-twins-plugin-for-grafana)
-- [Usage](#usage)
-- [Publications](#publications)
-- [License](#license)
-
-## Changelog
-
-## Architecture
-
-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](/components).
-
-
-
-- 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/).
- - [Eclipse Hono](https://www.eclipse.org/hono/).
- - [Apache Kafka](https://kafka.apache.org/). It works as an intermediary between Eclipse Ditto and Telegraf, as they cannot connect directly (they need a component that acts as a broker).
- - [Telegraf](https://www.influxdata.com/time-series-platform/telegraf/). This is the recommended data collector for InfluxDB databases. It is in charge of constantly consuming the given Kafka topic and writing the received messages to the specified InfluxDB database.
- - [InfluxDB](https://www.influxdata.com/products/influxdb-overview/).
- - [Grafana](https://grafana.com/oss/grafana/).
- - [Digital Twins plugin for Grafana](https://github.com/ertis-research/digital-twins-plugin-for-Grafana/).
- - [Extended API for Eclipse Ditto](https://github.com/ertis-research/extended-api-for-Eclipse-Ditto/).
-- The **yellow part**...
-- The **red part**...
-
-## Deploy platform in a fast way
-### Requirements to deploy using Helm
-- [Docker](https://www.docker.com/)
-- [Kubernetes](https://kubernetes.io/)
-- [Helm](https://helm.sh/)
-
-### Steps to deploy platform using Helm
-*Currently in development*
-
-## Deploy platform manually
-This section will explain how to deploy the platform manually. Basically, you will have to deploy or install the different components and then connect them. The procedure explained below is the one followed to deploy them in **Kubernetes** using in most cases the **Helm** option, but any other installation in which all the components are correctly installed and there is some kind of network between them to be able to communicate can be used.
-
-It is not necessary to deploy all components if not all functionalities are to be used. Check the [architecture](#architecture) section to find out which ones are essential and what functionality is covered by each of them.
-
-### Requirements to deploy manually
-- [Docker](https://www.docker.com/)
-- [Kubernetes](https://kubernetes.io/)
-- [Helm](https://helm.sh/)
-
-### Steps to deploy platform manually
-We recommend installing all components in the same Kubernetes namespace to make it easier to identify and control them all. In our case the namespace name will be stored in a bash variable called **NS**.
-
-Also note that the values files have the variables that we recommend for the installation of each Helm Chart, but they can be extended or modified according to your needs (to do so, please consult the Helm Chart documentation).
-
-#### Deploying Eclipse Ditto and Eclipse Hono
-To deploy both Eclipse Ditto and Eclipse Hono we will directly install the [cloud2edge package](https://www.eclipse.org/packages/packages/cloud2edge/), which is specially created to allow these two tools to connect correctly.
-Before executing the commands we will need to have the files [pv-hono.yaml](files_for_manual_deploy/pv-hono.yaml), [pv-mongodb.yaml](files_for_manual_deploy/pv-mongodb.yaml), [pvc-mongodb.yaml](files_for_manual_deploy/pvc-mongodb.yaml) and [values-cloud2edge.yaml](files_for_manual_deploy/values-cloud2edge.yaml) in the folder where we are in the terminal.
-Once ready, and complying with all the [prerequisites](https://www.eclipse.org/packages/prereqs/) of the package, we execute the following commands.
-```sh
-helm repo add eclipse-iot https://eclipse.org/packages/charts
-helm repo update
-
-kubectl create namespace $NS
-kubectl apply -f pv-hono.yaml -n $NS
-kubectl apply -f pv-mongodb.yaml -n $NS
-kubectl apply -f pvc-mongodb.yaml -n $NS
-
-helm install -n $NS --wait --timeout 15m dt eclipse-iot/cloud2edge --version=0.2.3 -f values-cloud2edge.yaml --dependency-update --debug
-```
-If all pods are running and ready we already have the first two components installed.
-
-#### Deploying Apache Kafka
-To deploy Kafka, the yaml files from another project have been reused, but it could also be installed [using Helm](https://github.com/bitnami/charts/tree/master/bitnami/kafka) if you prefer.
-
-For Kafka to work, it is necessary to install [ZooKeeper](https://zookeeper.apache.org/) beforehand. In addition, [CMAK](https://github.com/deltaprojects/kafka-manager-docker), a tool to manage Apache Kafka, will be used to make it easier to use. Then, for the deployment, the [pod-zookeeper.yaml](files_for_manual_deploy/pod-zookeeper.yaml), [svc-zookeeper.yaml](files_for_manual_deploy/svc-zookeeper.yaml), [pod-kafka.yaml](files_for_manual_deploy/pod-kafka.yaml), [svc-kafka.yaml](files_for_manual_deploy/svc-kafka.yaml), [deploy-kafka-manager.yaml](files_for_manual_deploy/deploy-kafka-manager.yaml) and [svc-kafka-manager.yaml](files_for_manual_deploy/svc-kafka-manager.yaml) files will be needed. Once you have them, you only need to apply them to the chosen namespace.
-```sh
-kubectl apply -f pod-zookeeper.yaml -n $NS
-kubectl apply -f svc-zookeeper.yaml -n $NS
-
-kubectl apply -f pod-kafka.yaml -n $NS
-kubectl apply -f svc-kafka.yaml -n $NS
-
-kubectl apply -f deploy-kafka-manager.yaml -n $NS
-kubectl apply -f svc-kafka-manager.yaml -n $NS
-```
-
-#### Deploying InfluxDB
-For InfluxDB, [Helm](https://github.com/influxdata/helm-charts/tree/master/charts/influxdb2) will again be used for deployment. The following [sc-influxdb2.yaml](files_for_manual_deploy/sc-influxdb2.yaml) and [pv-influxdb2.yaml](files_for_manual_deploy/pv-influxdb2.yaml) files will be required to be applied before installation. In addition, the recommended values are in the [values-influxdb2.yaml](files_for_manual_deploy/values-influxdb2.yaml) file (it is recommended that you check it before installing and change the *password* variable to your preference).
-
-```sh
-helm repo add influxdata https://helm.influxdata.com/
-
-kubectl apply -f sc-influxdb2.yaml -n $NS
-kubectl apply -f pv-influxdb2.yaml -n $NS
-
-helm install -n $NS influxdb influxdata/influxdb2 -f values-influxdb2.yaml --version=2.0.10
-```
-
-#### Deploying Grafana
-Deploying Grafana is very similar to InfluxDB. We will have to apply the file [pv-grafana.yaml](files_for_manual_deploy/pv-grafana.yaml) and install the [Helm Chart](https://github.com/grafana/helm-charts/tree/main/charts/grafana) with the values of the [values-grafana.yaml](files_for_manual_deploy/values-grafana.yaml) file (it is also recommended to modify the *password* variable).
-```sh
-helm repo add grafana https://grafana.github.io/helm-charts
-
-kubectl apply -f pv-grafana.yaml -n $NS
-
-helm install -n $NS grafana grafana/grafana -f values-grafana.yaml --version=6.26.3
-```
-
-#### Connecting Eclipse Hono and Eclipse Ditto
-In the following diagram you can see how Eclipse Hono and Eclipse Ditto are related in our platform.
-
-
-
-
-
-Basically, you will need to **create a connection between both for each Eclipse Hono tenant you want to use**. [Tenants](https://www.eclipse.org/hono/docs/concepts/tenancy/) basically act as device containers, so you could simply create a single tenant connected to Eclipse Ditto and store all the devices you need there. In this case we will do it this way, but you could create as many tenants and connections as your needs require.
-
-The first thing to do is to check the IPs and ports to use with `kubectl get services -n $NS`. At this point we are interested in the *dt-service-device-registry-ext* and *dt-ditto-nginx* services, which correspond to Eclipse Hono and Eclipse Ditto respectively (if you have followed these instructions and services are NodePort, you will have to use port 3XXXX).
-
-We will then create a Hono tenant called, for example, ditto (you must override the variable **HONO_TENANT** if you have chosen another name).
-```sh
-HONO_TENANT=ditto
-curl -i -X POST http://$HONO_IP:$HONO_PORT/v1/tenants/$HONO_TENANT
-```
-
-Now we will create the connection from Eclipse Ditto, which will act as a consumer of the AMQP endpoint of that tenant. To do this you will need to know the Eclipse Ditto devops password with the following command (the variable **RELEASE** is the name we gave to the Helm release when installing cloud2edge, if you have followed these instructions it should be dt).
-```sh
-RELEASE=dt
-DITTO_DEVOPS_PWD=$(kubectl --namespace ${NS} get secret ${RELEASE}-ditto-gateway-secret -o jsonpath="{.data.devops-password}" | base64 --decode)
-```
-Now we [create the connection from Eclipse Ditto](https://www.eclipse.org/ditto/connectivity-manage-connections.html#create-connection) with the following command.
-
- Show command
-
-```sh
-curl -i -X POST -u devops:${DITTO_DEVOPS_PWD} -H 'Content-Type: application/json' --data '{
- "targetActorSelection": "/system/sharding/connection",
- "headers": {
- "aggregate": false
- },
- "piggybackCommand": {
- "type": "connectivity.commands:createConnection",
- "connection": {
- "id": "hono-connection-for-'"${HONO_TENANT}"'",
- "connectionType": "amqp-10",
- "connectionStatus": "open",
- "uri": "amqp://consumer%40HONO:verysecret@'"${RELEASE}"'-dispatch-router-ext:15672",
- "failoverEnabled": true,
- "sources": [
- {
- "addresses": [
- "telemetry/'"${HONO_TENANT}"'",
- "event/'"${HONO_TENANT}"'"
- ],
- "authorizationContext": [
- "pre-authenticated:hono-connection"
- ],
- "enforcement": {
- "input": "{{ header:device_id }}",
- "filters": [
- "{{ entity:id }}"
- ]
- },
- "headerMapping": {
- "hono-device-id": "{{ header:device_id }}",
- "content-type": "{{ header:content-type }}"
- },
- "replyTarget": {
- "enabled": true,
- "address": "{{ header:reply-to }}",
- "headerMapping": {
- "to": "command/'"${HONO_TENANT}"'/{{ header:hono-device-id }}",
- "subject": "{{ header:subject | fn:default(topic:action-subject) | fn:default(topic:criterion) }}-response",
- "correlation-id": "{{ header:correlation-id }}",
- "content-type": "{{ header:content-type | fn:default('"'"'application/vnd.eclipse.ditto+json'"'"') }}"
- },
- "expectedResponseTypes": [
- "response",
- "error"
- ]
- },
- "acknowledgementRequests": {
- "includes": [],
- "filter": "fn:filter(header:qos,'"'"'ne'"'"','"'"'0'"'"')"
- }
- },
- {
- "addresses": [
- "command_response/'"${HONO_TENANT}"'/replies"
- ],
- "authorizationContext": [
- "pre-authenticated:hono-connection"
- ],
- "headerMapping": {
- "content-type": "{{ header:content-type }}",
- "correlation-id": "{{ header:correlation-id }}",
- "status": "{{ header:status }}"
- },
- "replyTarget": {
- "enabled": false,
- "expectedResponseTypes": [
- "response",
- "error"
- ]
- }
- }
- ],
- "targets": [
- {
- "address": "command/'"${HONO_TENANT}"'",
- "authorizationContext": [
- "pre-authenticated:hono-connection"
- ],
- "topics": [
- "_/_/things/live/commands",
- "_/_/things/live/messages"
- ],
- "headerMapping": {
- "to": "command/'"${HONO_TENANT}"'/{{ thing:id }}",
- "subject": "{{ header:subject | fn:default(topic:action-subject) }}",
- "content-type": "{{ header:content-type | fn:default('"'"'application/vnd.eclipse.ditto+json'"'"') }}",
- "correlation-id": "{{ header:correlation-id }}",
- "reply-to": "{{ fn:default('"'"'command_response/'"${HONO_TENANT}"'/replies'"'"') | fn:filter(header:response-required,'"'"'ne'"'"','"'"'false'"'"') }}"
- }
- },
- {
- "address": "command/'"${HONO_TENANT}"'",
- "authorizationContext": [
- "pre-authenticated:hono-connection"
- ],
- "topics": [
- "_/_/things/twin/events",
- "_/_/things/live/events"
- ],
- "headerMapping": {
- "to": "command/'"${HONO_TENANT}"'/{{ thing:id }}",
- "subject": "{{ header:subject | fn:default(topic:action-subject) }}",
- "content-type": "{{ header:content-type | fn:default('"'"'application/vnd.eclipse.ditto+json'"'"') }}",
- "correlation-id": "{{ header:correlation-id }}"
- }
- }
- ]
- }
- }
-}' http://$DITTO_IP:$DITTO_PORT/devops/piggyback/connectivity
-```
-
-
-This connection is configured so that if an [Eclipse Hono device](https://www.eclipse.org/hono/docs/concepts/device-identity/) has the [ThingId](https://www.eclipse.org/ditto/basic-thing.html#thing-id) of an Eclipse Ditto twin as its identifier, its messages will be redirected to that twin directly (explained in more detail in the [usage](#usage) section).
-
-
-#### Connecting Eclipse Ditto and Kafka
-To connect Eclipse Ditto to Kafka we will need to create a topic in Kafka and a Ditto connection to it. All [events](https://www.eclipse.org/ditto/basic-connections.html#target-topics-and-filtering) that occur in any of the Eclipse Ditto twins will be sent to this topic. You could also filter these events by twin or namespace and create several connections to multiple topics, but this is not really necessary and adds some complexity.
-
-To create the topic in Kafka the above deployed manager will be used. Check the IP and port of Kafka's manager with `kubectl get services -n $NS` and access it in a browser. Already on the page, if you don't have a cluster created, create a new one and create a topic inside it. In our case this topic will be called *digitaltwins*.
-
-To create a cluster go to `Cluster > Add Cluster` and fill in at least the name and host of Zookeeper (if our files are used you will have to put *zookeeper-1:2181*). The other settings can be left as default. It should look like the image.
-
-
-
-
-
-After creating it, access it and go to `Topic > Create` to create a new topic. Here it is only necessary to assign a name.
-
-
-
-
-
-Once the topic is created we have to create a [Kafka target connection](https://www.eclipse.org/ditto/connectivity-protocol-bindings-kafka2.html#target-format) in Eclipse Ditto, where it will be indicated that we want it to publish all events. You will need the Ditto devops password obtained in [the previous section](#connecting-eclipse-hono-and-eclipse-ditto).
-
-
- Show command
-
-```sh
-curl -i -X POST -u devops:${DITTO_DEVOPS_PWD} -H 'Content-Type: application/json' --data '{
- "targetActorSelection": "/system/sharding/connection",
- "headers": {
- "aggregate": false
- },
- "piggybackCommand": {
- "type": "connectivity.commands:createConnection",
- "connection": {
- "id": "kafka-connection",
- "name": "kafka-connection",
- "connectionType": "kafka",
- "connectionStatus": "open",
- "failoverEnabled": true,
- "uri": "tcp://kafka-cluster:9094",
- "specificConfig": {
- "bootstrapServers": "kafka-cluster:9094",
- "saslMechanism": "plain"
- },
- "sources": [],
- "targets": [
- {
- "address": "digitaltwins",
- "topics": [
- "_/_/things/twin/events?extraFields=thingId,attributes/_parents,features/idSimulationRun/properties/value",
- "_/_/things/live/messages"
- ],
- "authorizationContext": [
- "nginx:ditto"
- ]
- }
- ]
- }
- }
-}' http:///$DITTO_IP:$DITTO_PORT/devops/piggyback/connectivity
-```
-
-
-
-If the connection is successfully established, Eclipse Ditto and Kafka are already connected.
-
-#### Connecting Kafka and InfluxDB: Deploying Telegraf
-
-Telegraf will be in charge of collecting the messages posted in the created Kafka topic and write the relevant information in InfluxDB, i.e. it will connect both tools. Telegraf consists of input and output plugins. In our case we will use the [kafka consumer input plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/kafka_consumer) and the [InfluxDB v2.x output plugin](https://github.com/influxdata/telegraf/tree/release-1.23/plugins/outputs/influxdb_v2). The Telegraf configuration will be defined in its telegraf-values.yaml file, before deployment. This will be written in YAML as another installation variable and will be automatically transformed to [TOML](https://github.com/toml-lang/toml#toml) during deployment.
-
-First of all we need to get a token from InfluxDB that gives Telegraf at least write permissions. To do this we access the InfluxDB interface (ip and port of its service) and go to `Data > API Tokens`. Click on *Generate API Token* and select *All Access API Token*. Assign any name, save and select the token we have just created to copy it to the clipboard. This is stored in a variable called **INFLUX_TOKEN**.
-
-```sh
-export INFLUX_TOKEN=
-```
-
-
-
-
-
-You also need to store in variables the URLs of both Kafka and InfluxDB (follow the format IP:PORT), as well as the name of the Kafka topic. These variables will be **INFLUX_URL**, **KAFKA_BROKER** and **KAFKA_TOPIC**. Once all variables are ready, Telegraf can be displayed with the values defined in the [values-telegraf.yaml](files_for_manual_deploy/values-telegraf.yaml) file.
-
-```sh
-helm upgrade --install -n $NS test-telegraf influxdata/telegraf \
- -f values-telegraf.yaml \
- --version=1.8.27 \
- --set config.outputs[0].influxdb_v2.token=$INFLUX_TOKEN \
- --set config.outputs[0].influxdb_v2.urls[0]=$INFLUX_URL \
- --set config.inputs[0].kafka_consumer.brokers[0]=$KAFKA_BROKER \
- --set config.inputs[0].kafka_consumer.topics[0]=$KAFKA_TOPIC
-```
-
-If the pod is ready and running it should be working, but it is advisable to check its logs to make sure.
-
-```sh
-kubectl logs -f --namespace $NS $(kubectl get pods --namespace $NS -l app.kubernetes.io/name=telegraf -o jsonpath='{ .items[0].metadata.name }')
-```
-
-#### Connecting InfluxDB and Grafana
-Connecting these two tools is very simple. The first thing to do is to get a full access token for Grafana in InfluxDB, as explained in the [previous section](#connecting-kafka-and-influxdb-deploying-telegraf). Then, access `Configuration > Data sources` on the Grafana interface and click on *Add data source*. Select *InfluxDB* from the list. In the settings it is very important to select *Flux* as query language. It will be necessary to fill in the URL section with the one that corresponds to InfluxDB. You will also have to activate Auth Basic and fill in the fields (in our case we have set the default admin of InfluxDB, but you can create a new user and fill in these fields). In the InfluxDB details you should indicate the organisation (default is *influxdata*), the bucket (default is *default*) and the token you have generated. When saving and testing, it should come out that at least one bucket has been found, indicating that they are already connected.
-
-
-
-
-
-#### Deploying Extended API for Eclipse Ditto
-Gets the IP and port from Eclipse Ditto and check [documentation](https://github.com/ertis-research/extended-api-for-eclipse-ditto).
-
-#### Installing Digital Twins plugin for Grafana
-Check [documentation](https://github.com/ertis-research/digital-twins-plugin-for-grafana).
-
-#### Deploying Kafka-ML
-This tool acts like a black box. To deploy it check its [documentation](https://github.com/ertis-research/kafka-ml).
-
-#### Deploying and connecting Eclipse Hono to Kafka-ML
-Check [documentation](https://github.com/ertis-research/Eclipse-Hono-to-Kafka-ML).
-
-#### Deploying and connecting Error Detection for Eclipse Hono with Kafka-ML
-Check [documentation](https://github.com/ertis-research/error-detection-for-Eclipse-Hono-with-Kafka-ML).
-
-#### Connecting Kafka-ML and Eclipse Ditto: Two options
-To connect Kafka-ML and Eclipse Ditto we have two options. When the development of this platform started, the source connection through Kafka was not implemented in Eclipse Ditto, so an intermediate service had to be created to send the information from Kafka-ML to one of the available protocols, more specifically AMQP, modifying the message to Ditto Protocol format on the way. It is currently possible to create such a connection, so there are two options for connecting these tools. The first is more direct and saves the deployment of two services, while the second can facilitate the connection and management of several models in the long-term.
-
-##### Option 1: Create Eclipse Ditto connection
-
-##### Option 2: Using AMQP
-
-###### Deploying Kafka-ML to Eclipse Ditto
-Check [documentation](https://github.com/ertis-research/kafka-ml-to-eclipse-ditto).
-
-###### Deploying RabbitMQ
-For its deployment we will use [Helm](https://github.com/bitnami/charts/tree/master/bitnami/rabbitmq) as in most technologies and, therefore, the [sc-rabbitmq.yaml](files_for_manual_deploy/sc-rabbitmq.yaml), [pv-rabbitmq.yaml](files_for_manual_deploy/pv-rabbitmq.yaml), [pvc-rabbitmq.yaml](files_for_manual_deploy/pvc-rabbitmq.yaml) and [values-rabbitmq.yaml](files_for_manual_deploy/values-rabbitmq.yaml) files will be needed.
-
-```sh
-helm repo add bitnami https://charts.bitnami.com/bitnami
-
-kubectl apply -f sc-rabbitmq.yaml -n $NS
-kubectl apply -f pv-rabbitmq.yaml -n $NS
-kubectl apply -f pvc-rabbitmq.yaml -n $NS
-
-helm install rabbitmq bitnami/rabbitmq -n $NS -f values-rabbitmq.yaml --version=9.0.2
-```
-
-###### Conecting RabbitMQ and Eclipse Ditto
-
-We are working on it...
-
-
- Show command
-
-```sh
-curl -i -X POST -u devops:${DITTO_DEVOPS_PWD} -H 'Content-Type: application/json' --data '{
- "targetActorSelection": "/system/sharding/connection",
- "headers": {
- "aggregate": false
- },
- "piggybackCommand": {
- "type": "connectivity.commands:createConnection",
- "connection": {
- "id": "kafkaml-connection-for-'"${HONO_TENANT}"'",
- "connectionType": "amqp-091",
- "connectionStatus": "open",
- "uri": "amqp://kafkaml:kafkaml@rabbitmq:32473",
- "failoverEnabled": true,
- "sources": [
- {
- "addresses": [
- "telemetry_raspberry"
- ],
- "authorizationContext": [
- "pre-authenticated:kafkaml-connection"
- ]
- }
- ]
- }
- }
-}' http:///$DITTO_IP:$DITTO_PORT/devops/piggyback/connectivity
-```
-
-
-
-#### Installing Unity plugin for Grafana
-Check [documentation](https://github.com/ertis-research/unity-plugin-for-grafana).
-
-## Deploy lightweight version of the platform for IoT devices
-
-## Usage
-
-## Publications
-
-## License
-
-
-
-
-
-
-
+[https://github.com/ertis-research/OpenTwins](https://ertis-research.github.io/OpenTwins/)
\ No newline at end of file
diff --git a/docs/docs/getting-started/_category_.json b/docs/docs/examples/_category_.json
similarity index 86%
rename from docs/docs/getting-started/_category_.json
rename to docs/docs/examples/_category_.json
index 1ec710b..52773df 100644
--- a/docs/docs/getting-started/_category_.json
+++ b/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."
diff --git a/docs/docs/getting-started/ball-example.md b/docs/docs/examples/ball-example.md
similarity index 100%
rename from docs/docs/getting-started/ball-example.md
rename to docs/docs/examples/ball-example.md
diff --git a/docs/docs/getting-started/raspberry-example/Untitled.png b/docs/docs/examples/raspberry-example/Untitled.png
similarity index 100%
rename from docs/docs/getting-started/raspberry-example/Untitled.png
rename to docs/docs/examples/raspberry-example/Untitled.png
diff --git a/docs/docs/getting-started/raspberry-example/raspberry-example.mdx b/docs/docs/examples/raspberry-example/raspberry-example.mdx
similarity index 100%
rename from docs/docs/getting-started/raspberry-example/raspberry-example.mdx
rename to docs/docs/examples/raspberry-example/raspberry-example.mdx
diff --git a/docs/docs/getting-started/raspberry-example/sending-data.mdx b/docs/docs/examples/raspberry-example/sending-data.mdx
similarity index 100%
rename from docs/docs/getting-started/raspberry-example/sending-data.mdx
rename to docs/docs/examples/raspberry-example/sending-data.mdx
diff --git a/docs/docs/getting-started/string-example.md b/docs/docs/examples/string-example.md
similarity index 100%
rename from docs/docs/getting-started/string-example.md
rename to docs/docs/examples/string-example.md
diff --git a/docs/docs/guides/_category_.json b/docs/docs/guides/_category_.json
index 83df68a..b68e4a3 100644
--- a/docs/docs/guides/_category_.json
+++ b/docs/docs/guides/_category_.json
@@ -1,6 +1,6 @@
{
- "label": "Advanced guides",
- "position": 5,
+ "label": "Guides",
+ "position": 4,
"link": {
"type": "generated-index"
}
diff --git a/docs/docs/installation/using-helm.md b/docs/docs/installation/using-helm.md
index 4cf84a9..9c9a860 100644
--- a/docs/docs/installation/using-helm.md
+++ b/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.
diff --git a/docs/docs/overview/_category_.json b/docs/docs/overview/_category_.json
new file mode 100644
index 0000000..5f322d2
--- /dev/null
+++ b/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."
+ }
+}
\ No newline at end of file
diff --git a/docs/docs/architecture.md b/docs/docs/overview/architecture.md
similarity index 97%
rename from docs/docs/architecture.md
rename to docs/docs/overview/architecture.md
index 9e51523..bf8ccf0 100644
--- a/docs/docs/architecture.md
+++ b/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).
-
+
- 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/).
diff --git a/docs/docs/overview/concepts.md b/docs/docs/overview/concepts.md
new file mode 100644
index 0000000..9e0c0c5
--- /dev/null
+++ b/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.
+
+:::
diff --git a/docs/docs/intro.md b/docs/docs/overview/purpose.md
similarity index 97%
rename from docs/docs/intro.md
rename to docs/docs/overview/purpose.md
index eef8e7c..ffb4183 100644
--- a/docs/docs/intro.md
+++ b/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.
:::
-
diff --git a/docs/docs/quickstart.md b/docs/docs/quickstart.md
new file mode 100644
index 0000000..3e119b8
--- /dev/null
+++ b/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
\ No newline at end of file
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
index b07444e..2ebc64a 100644
--- a/docs/docusaurus.config.js
+++ b/docs/docusaurus.config.js
@@ -65,7 +65,7 @@ const config = {
items: [
{
type: 'doc',
- docId: 'intro',
+ docId: 'quickstart',
position: 'left',
label: 'Documentation',
},
diff --git a/docs/src/components/Homepage/customNavbar.tsx b/docs/src/components/Homepage/customNavbar.tsx
index 135afbc..807732d 100644
--- a/docs/src/components/Homepage/customNavbar.tsx
+++ b/docs/src/components/Homepage/customNavbar.tsx
@@ -13,7 +13,7 @@ export default function CustomNavbar(): JSX.Element {
+ to="/docs/quickstart">
documentation
+ to="/docs/quickstart">
Get started
+ to="/docs/quickstart">
Introduction
-
-
-
-
-