Add basic doc structure

calaos · Mar 6, 2024 · 9bf674a · 9bf674a
1 parent f6fba58
commit 9bf674a
Show file tree

Hide file tree

Showing 119 changed files with 645 additions and 198 deletions.
diff --git a/archetypes/default.md b/archetypes/default.md
@@ -1,5 +1,4 @@
 +++
 title = '{{ replace .File.ContentBaseName "-" " " | title }}'
 date = {{ .Date }}
-draft = true
 +++
diff --git a/content/_index.en.md b/content/_index.en.md
@@ -3,83 +3,14 @@ title = ""
 date = 2024-01-31T08:43:16Z
 weight = 5
 chapter = true
-pre = "<b>X. </b>"
 +++
 
 ### Welcome to Calaos Documentation
 
-# Some Chapter title
+# CALAOS
 
-The documentation covers all the topics around the installation, setup, configuration, and usage of Calaos.
+Calaos is a home automation project based on different software layers. This website is the documentation for the latest version: **v4**. This documentation covers all the topics around the installation, setup, configuration, and usage of Calaos.
 
-## Getting started
-### Requirements
-### Installation
-### Configuration
-#### Create an I/O
-#### Create a rule
-#### Upload your config
-#### Test
-
-## Supported Hardware
-
-### Wago PLC
-#### Codesys
-#### Input Modules
-#### Output Modules
-#### Dali Modules
-#### DMX Modules
-#### Degraded mode
-
-### KNX
-### MQTT
-### Zigbee
-### Dali
-### DMX
-### OneWire
-### WebIO
-### GPIO
-### Camera
-### Music
-### Audio Receivers
-
-## Calaos Installer
-
-### Create Rooms
-### Create IOs
-#### Internal variables
-### Scenarios
-### Time Scheduling
-### Create Rules
-### LUA Scripting
-### Wago Configuration
-
-
-## Calaos OS
-### Installation
-### Configuration
-#### Network
-#### Services
-#### Logs
-#### calaos_config
-#### TouchScreen
-#### Date/Time/Timezone
-#### Language
-#### e-mail
-
-
-#### calaos_ddns
-### Update
-### Roll Back / Restore
-
-
-## Examples of use
-### 
-
-## Calaos SW Stack
-### Calaos Server
-### Calaos Home
-### Calaos Mobile
-### Calaos WebApp
-### Calaos config
-### Calaos DDNS
+{{% notice note %}}
+This site does not document earlier versions of Calaos: v1, v2, v3.
+{{% /notice %}}
diff --git a/content/_index.fr.md b/content/_index.fr.md
@@ -3,124 +3,14 @@ title = ""
 date = 2024-01-31T08:43:17Z
 weight = 5
 chapter = true
-pre = "<b>X. </b>"
 +++
 
 ### Bienvenue dans la documentation de Calaos
 
-# Some Chapter title
+# CALAOS
 
-La documentation couvre tous les sujets concernant l'installation, la configuration et l'utilisation de Calaos.
+Calaos est un projet de domotique basé sur différentes couches logicielles. Ce site est la documentation de la dernière version: **v4**. Cette documentation couvre tous les sujets relatifs à l'installation, au paramétrage, à la configuration et à l'utilisation de Calaos.
 
-## Débuter
-### Pré-requis
-
-Pour installer Calaos, vous aurez besoin de:
-- Un ordinateur, de type Intel
-- avec un disque dur avec une capacité de 16GB minimum
-- et 1GB Ram
-- Un écran, clavier et souris
-- Une clef USB de 4GB minimum pour l'installation
-
-Pour commencer, téléchargez Calaos Installer a cette addresse : TODO lien vers Calaos installer. Ce dernier est compatible avec les systèmes d'exploitation Windows, Mac et Linux.
-Une fois téléchargée, lancer l'application.
-
-![alt text](calaos_installer_fr.png)
-
-![alt text](create_image_fr.png)
-
-Choisir la dernier version stable de Calaos OS dans la liste déroulante, puis cliquer sur "Continuer".
-L'image est alors téléchargée depuis le serveur de Calaos. Cette opération peut prendre quelques minutes et depends de la vitesse de votre connexion internet.
-Une fois le téléchargement terminé, insérer une clef USB dans votre ordinateur. Celle-ci sera formatée et les fichiers de l'image seront copiés dessus.
-La clé USB devrait apparraitre dans la fenêtre de l'application. Choisir la clé USB puis cliquer sur "Continue".
-
-Une fois l'image copiée sur la clé USB, vous pouvez l'insérer dans le PC qui servira de serveur Calaos. Redémarrer le PC et booter sur la clé USB. L'installation de Calaos OS démarre alors.
-Lorsque Calaos OS demarre vous avez deux possibilités:
-- Utiliser Calaos OS en mode "Live" pour tester le système sans l'installer
-- Installer Calaos OS sur le disque dur de votre PC
-
-Le mode "Live" vous permettre de configurer votre systeme, de tester les fonctionnalités et de voir si tout fonctionne correctement. Si vous êtes satisfait, vous pouvez alors installer Calaos OS sur le disque dur du serveur. Vous garderez alors toutes les configurations que vous avez faites en mode "Live".
-
-Lorsque le le mode "Live" a demarré, L'interface graphique de Calaos OS apparait sur l'écran. Vous pouvez alors configurer votre systeme, ajouter des I/O, des règles, des scénarios. Pour le moment l'interface est vide, mais nous allons voir comment la configurer.
-
-Pour configurer votre installation vous avez besoin de Calaos Installer.
-Lancer le logiciel sur votre PC, et commencer la configuration.
-
-Vous pouvez creer une pièce, et donnez lui le nom que vous voulez.
-Maintenant vous pouvez attacher une nouvelle I/O (Input/Ouput ou Entree/Sortie) a cette Piece.
-Créeons par exemple une Sortie de type Lumiere.
-
-
-
-
-
-
-
-### Installation
-### Configuration
-#### Creation d'une I/O
-#### Creation d'une règle
-#### Upload de la config
-#### Test
-
-## Materiel Supportés
-### Automate Wago
-#### Codesys
-#### Modules entrées
-#### Modules sorties
-#### Modules DALI
-#### Modules DMX
-#### Mode dégradé
-
-### KNX
-### MQTT
-### Zigbee
-### Dali
-### DMX
-### OneWire
-### WebIO
-### GPIO
-### Camera
-### Music
-### Audio Receivers
-
-## Calaos Installer
-
-### Create Rooms
-### Create IOs
-#### Internal variables
-### Scenarios
-### Time Scheduling
-### Create Rules
-### LUA Scripting
-### Wago Configuration
-
-
-## Calaos OS
-### Installation
-### Configuration
-#### Network
-#### Services
-#### Logs
-#### calaos_config
-#### TouchScreen
-#### Date/Time/Timezone
-#### Language
-#### e-mail
-
-
-#### calaos_ddns
-### Update
-### Roll Back / Restore
-
-
-## Examples of use
-### 
-
-## Calaos SW Stack
-### Calaos Server
-### Calaos Home
-### Calaos Mobile
-### Calaos WebApp
-### Calaos config
-### Calaos DDNS
+{{% notice note %}}
+Ce site ne documente pas les versions antérieures de Calaos: v1, v2, v3.
+{{% /notice %}}
diff --git a/content/calaos_installer/_index.en.md b/content/calaos_installer/_index.en.md
@@ -0,0 +1,12 @@
++++
+title = "Calaos Installer"
+date = 2024-03-06T19:56:48Z
+weight = 30
+chapter = true
++++
+
+### Chapter X
+
+# Some Chapter title
+
+Lorem Ipsum.
diff --git a/content/calaos_installer/_index.fr.md b/content/calaos_installer/_index.fr.md
@@ -0,0 +1,12 @@
++++
+title = "Calaos Installer"
+date = 2024-03-06T19:56:46Z
+weight = 30
+chapter = true
++++
+
+### Chapter X
+
+# Some Chapter title
+
+Lorem Ipsum.
diff --git a/content/calaos_installer/internal_var.en.md b/content/calaos_installer/internal_var.en.md
@@ -0,0 +1,5 @@
++++
+title = 'Internal Variable'
+date = 2024-03-06T20:12:36Z
+weight = 30
++++
diff --git a/content/calaos_installer/internal_var.fr.md b/content/calaos_installer/internal_var.fr.md
@@ -0,0 +1,5 @@
++++
+title = 'Variable interne'
+date = 2024-03-06T20:12:37Z
+weight = 30
++++
diff --git a/content/calaos_installer/io.en.md b/content/calaos_installer/io.en.md
@@ -0,0 +1,5 @@
++++
+title = 'Create IOs'
+date = 2024-03-06T20:12:25Z
+weight = 20
++++
diff --git a/content/calaos_installer/io.fr.md b/content/calaos_installer/io.fr.md
@@ -0,0 +1,5 @@
++++
+title = 'Créer des IO'
+date = 2024-03-06T20:12:23Z
+weight = 20
++++
diff --git a/content/calaos_installer/rooms.en.md b/content/calaos_installer/rooms.en.md
@@ -0,0 +1,5 @@
++++
+title = 'Create rooms'
+date = 2024-03-06T20:12:16Z
+weight = 10
++++
diff --git a/content/calaos_installer/rooms.fr.md b/content/calaos_installer/rooms.fr.md
@@ -0,0 +1,5 @@
++++
+title = 'Créer des pièces'
+date = 2024-03-06T20:12:18Z
+weight = 10
++++
diff --git a/content/calaos_installer/rules.en.md b/content/calaos_installer/rules.en.md
@@ -0,0 +1,5 @@
++++
+title = 'Create rules'
+date = 2024-03-06T20:13:03Z
+weight = 60
++++
diff --git a/content/calaos_installer/rules.fr.md b/content/calaos_installer/rules.fr.md
@@ -0,0 +1,5 @@
++++
+title = 'Créer des règles'
+date = 2024-03-06T20:13:01Z
+weight = 60
++++
diff --git a/content/calaos_installer/scenario.en.md b/content/calaos_installer/scenario.en.md
@@ -0,0 +1,5 @@
++++
+title = 'Scenario'
+date = 2024-03-06T20:12:47Z
+weight = 40
++++
diff --git a/content/calaos_installer/scenario.fr.md b/content/calaos_installer/scenario.fr.md
@@ -0,0 +1,5 @@
++++
+title = 'Scenario'
+date = 2024-03-06T20:12:45Z
+weight = 40
++++
diff --git a/content/calaos_installer/scripts.en.md b/content/calaos_installer/scripts.en.md
@@ -0,0 +1,5 @@
++++
+title = 'LUA Scripting'
+date = 2024-03-06T20:13:15Z
+weight = 70
++++
diff --git a/content/calaos_installer/scripts.fr.md b/content/calaos_installer/scripts.fr.md
@@ -0,0 +1,5 @@
++++
+title = 'Scripts en LUA'
+date = 2024-03-06T20:13:18Z
+weight = 70
++++
diff --git a/content/calaos_installer/time.en.md b/content/calaos_installer/time.en.md
@@ -0,0 +1,5 @@
++++
+title = 'Time scheduling'
+date = 2024-03-06T20:12:55Z
+weight = 50
++++
diff --git a/content/calaos_installer/time.fr.md b/content/calaos_installer/time.fr.md
@@ -0,0 +1,5 @@
++++
+title = 'Programmation horaire'
+date = 2024-03-06T20:12:57Z
+weight = 50
++++
diff --git a/content/calaos_installer/wago.en.md b/content/calaos_installer/wago.en.md
@@ -0,0 +1,5 @@
++++
+title = 'Wago Configuration'
+date = 2024-03-06T20:13:29Z
+weight = 80
++++
diff --git a/content/calaos_installer/wago.fr.md b/content/calaos_installer/wago.fr.md
@@ -0,0 +1,5 @@
++++
+title = 'Configuration Wago'
+date = 2024-03-06T20:13:28Z
+weight = 80
++++
diff --git a/content/calaos_installer_fr.png b/content/calaos_installer_fr.png
diff --git a/content/calaos_os/_index.en.md b/content/calaos_os/_index.en.md
@@ -0,0 +1,12 @@
++++
+title = "Calaos OS"
+date = 2024-03-06T19:57:32Z
+weight = 40
+chapter = true
++++
+
+### Chapter X
+
+# Some Chapter title
+
+Lorem Ipsum.
diff --git a/content/calaos_os/_index.fr.md b/content/calaos_os/_index.fr.md
@@ -0,0 +1,12 @@
++++
+title = "Calaos OS"
+date = 2024-03-06T19:57:32Z
+weight = 40
+chapter = true
++++
+
+### Chapter X
+
+# Some Chapter title
+
+Lorem Ipsum.
diff --git a/content/calaos_os/configuration/_index.en.md b/content/calaos_os/configuration/_index.en.md
@@ -0,0 +1,5 @@
++++
+title = 'Configuration'
+date = 2024-03-06T20:14:53Z
+weight = 30
++++
diff --git a/content/calaos_os/configuration/_index.fr.md b/content/calaos_os/configuration/_index.fr.md
@@ -0,0 +1,5 @@
++++
+title = 'Configuration'
+date = 2024-03-06T20:14:55Z
+weight = 30
++++
diff --git a/content/calaos_os/configuration/calaos_config.en.md b/content/calaos_os/configuration/calaos_config.en.md
@@ -0,0 +1,5 @@
++++
+title = 'calaos_config'
+date = 2024-03-06T20:15:28Z
+weight = 40
++++