Skip to content

Commit 32ef948

Browse files
feat(domotique): update
1 parent e51782f commit 32ef948

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+799
-521
lines changed

CODE_OF_CONDUCT.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# 🤝 Code de Conduite de la Communauté AyLabs
2+
3+
## Notre Engagement
4+
5+
Dans l'intérêt de favoriser un environnement ouvert et accueillant, nous nous engageons à faire de la participation à notre projet et à notre communauté une expérience exempte de harcèlement pour tous, quels que soient l'âge, la taille corporelle, le handicap visible ou invisible, l'ethnicité, le niveau d'expérience, la nationalité, l'apparence physique, la race, la religion, ou l'identité et l'orientation sexuelle.
6+
7+
## Nos Normes
8+
9+
Les exemples de comportement qui contribuent à créer un environnement positif comprennent :
10+
11+
* Faire preuve d'empathie et de gentillesse envers les autres.
12+
* Être attentif aux personnes d'origines et de points de vue différents.
13+
* Accepter poliment les critiques constructives.
14+
* Se concentrer sur ce qui est le mieux pour la communauté.
15+
* Faire preuve de courtoisie et de professionnalisme envers les autres membres de la communauté.
16+
17+
Les exemples de comportement inacceptable comprennent :
18+
19+
* L'utilisation de langage ou d'images sexualisés et l'attention ou l'approche sexuelle de toute nature.
20+
* Les commentaires insultants ou désobligeants, et les attaques personnelles ou politiques (trolling).
21+
* Le harcèlement public ou privé.
22+
* La publication d'informations privées d'autrui, telles que des adresses physiques ou électroniques, sans permission explicite.
23+
* Toute autre conduite qui pourrait raisonnablement être considérée comme inappropriée dans un cadre professionnel.
24+
25+
## Responsabilités d'Application
26+
27+
Les responsables du projet (mainteneurs) ont la responsabilité d'interpréter les normes de comportement acceptable et de prendre des mesures correctives appropriées et justes en réponse à tout comportement qui ne respecte pas ce Code de Conduite.
28+
29+
Les responsables du projet ont le droit et la responsabilité de supprimer, modifier ou rejeter les commentaires, commits, codes, modifications de wiki, problèmes (issues) et autres contributions qui ne sont pas alignés sur ce Code de Conduite, et de bannir temporairement ou définitivement tout contributeur pour d'autres comportements jugés inappropriés, menaçants, offensants ou nuisibles.
30+
31+
## Application
32+
33+
Les cas de comportement abusif, de harcèlement ou d'une autre manière inacceptable peuvent être signalés aux responsables du projet chargés de l'application à l'adresse suivante : **contact@aylabs.fr**
34+
35+
Tous les responsables du projet sont tenus de respecter la confidentialité et la vie privée de la personne signalant un incident.
36+
37+
### Lignes Directrices d'Application
38+
39+
Les responsables du projet suivront ces lignes directrices d'impact communautaire pour déterminer les conséquences de toute action qu'ils jugent contraire à ce Code de Conduite :
40+
41+
1. **Correction :** Utilisation d'avertissements non publics écrits. Aucune conséquence immédiate, mais le responsable du projet peut demander l'arrêt du comportement.
42+
2. **Avertissement :** Conséquences liées à une violation spécifique (ex: un blocage temporaire).
43+
3. **Bannissement Temporaire :** Suspension temporaire de la participation à la communauté pour une durée spécifiée.
44+
4. **Bannissement Permanent :** Exclusion définitive de toute participation au projet.
45+
46+
## Attribution
47+
48+
Ce Code de Conduite est adapté du [Contributor Covenant](https://www.contributor-covenant.org), version 2.1, disponible à [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
49+
50+
---

CONTRIBUTING.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# 🤝 Guide de Contribution à la Documentation AyLabs
2+
3+
Bienvenue ! Nous sommes ravis que vous souhaitiez contribuer à la documentation Domotique & Homelab d'AyLabs. Notre projet est 100% communautaire et Open Source.
4+
5+
Ce guide vous explique le processus à suivre pour soumettre vos modifications et articles.
6+
7+
## 🌟 Principes de Contribution
8+
9+
1. **Respect et Bienveillance :** Toutes les contributions sont les bienvenues. Soyez respectueux envers les autres contributeurs et les modérateurs.
10+
2. **Un Sujet = Une PR :** Pour faciliter la relecture et la validation, chaque Pull Request (PR) doit concerner un seul sujet (une correction, un nouvel article, ou une mise à jour d'un outil spécifique).
11+
3. **Langue :** Toutes les documentations doivent être rédigées en **français**.
12+
13+
---
14+
15+
## 📝 Standards de Contenu et Règles Spécifiques
16+
17+
Afin de maintenir la neutralité et la qualité du contenu, les règles suivantes s'appliquent à toutes les contributions :
18+
19+
### Liens d'Affiliation
20+
21+
| Type de Contribution | Règle d'Affiliation |
22+
| :--- | :--- |
23+
| **Création d'un article COMPLET** | **Autorisé.** Si vous rédigez un guide ou une revue complète et détaillée sur un produit/service, vous pouvez y apposer **votre propre lien affilié unique et clairement identifié comme tel** à la fin de l'article ou dans une section dédiée. |
24+
| **Modification/Correction mineure** | **Interdit.** L'ajout d'un lien affilié n'est pas permis pour de simples corrections, mises à jour ou modifications de contenu existant. |
25+
26+
### Contenu Multimédia
27+
28+
* Vous êtes autorisé à ajouter ou supprimer des **vidéos YouTube ou des liens vers des articles externes** si et seulement si leur contenu est **directement pertinent** et apporte une valeur ajoutée au sujet de l'article.
29+
30+
### Éthique et Qualité
31+
32+
* **Publicité Mensongère :** Il est strictement interdit d'insérer de la publicité mensongère, des informations trompeuses, ou de promouvoir des produits de manière déloyale.
33+
* **Respect du Travail Existant :** Toute modification ou réécriture doit être constructive. Il est interdit de dénigrer ou de discréditer le travail d'un précédent contributeur dans les articles de documentation ou dans les commentaires de PR.
34+
35+
---
36+
37+
## 🚀 Le Processus de Contribution (Fork & Pull Request)
38+
39+
Notre workflow de contribution s'articule autour de **GitHub Flow** :
40+
41+
### Étape 1 : Fork et Clonage
42+
43+
Pour proposer des modifications, vous devez créer votre propre copie (un **fork**) du dépôt original.
44+
45+
1. **Forkez** le dépôt : Rendez-vous sur la page GitHub du projet (`AyLabsCode/docs`) et cliquez sur le bouton **"Fork"** en haut à droite.
46+
2. **Clonez** votre fork en local sur votre machine. Remplacez `[VOTRE-NOM-UTILISATEUR]` par votre identifiant GitHub :
47+
48+
```bash
49+
git clone [https://github.com/](https://github.com/)[VOTRE-NOM-UTILISATEUR]/docs.git
50+
cd docs
51+
```
52+
3. **Créez une branche** pour vos modifications. Nommez la branche de manière descriptive (`fix/nom-article-corrigé` ou `feat/nouvel-article-mqtt`) :
53+
54+
```bash
55+
git checkout -b fix/mise-a-jour-zigbee2mqtt
56+
```
57+
58+
### Étape 2 : Développement et Tests
59+
60+
1. **Modifiez les fichiers :** Rédigez ou modifiez le contenu dans le dossier `docs/`.
61+
2. **Testez en local :** Il est crucial de vérifier que votre documentation s'affiche correctement avant de soumettre la PR.
62+
```bash
63+
# Installer les dépendances si ce n'est pas déjà fait
64+
yarn install
65+
# Lancer le serveur de développement Docusaurus
66+
yarn start
67+
```
68+
3. **Committez vos changements :** Utilisez des messages de commit clairs et concis.
69+
```bash
70+
git add .
71+
git commit -m "fix: corriger l'étape 3 du guide Zigbee2MQTT"
72+
```
73+
74+
### Étape 3 : Soumission de la Pull Request (PR)
75+
76+
1. **Poussez la branche** sur votre fork GitHub :
77+
```bash
78+
git push origin fix/mise-a-jour-zigbee2mqtt
79+
```
80+
2. **Ouvrez une Pull Request (PR) :** Sur la page GitHub de votre fork, cliquez sur **"Compare & pull request"**.
81+
* Assurez-vous que vous demandez à fusionner de votre branche vers la branche `main` du dépôt AyLabsCode/docs.
82+
* Décrivez clairement les objectifs de votre PR dans le champ de description.
83+
84+
---
85+
86+
## 🤖 Vérification par la CI/CD
87+
88+
Une fois votre Pull Request soumise, un processus d'**Intégration Continue (CI)** s'exécute automatiquement.
89+
90+
Ce système a pour rôle de :
91+
92+
1. **Vérifier la syntaxe :** S'assurer qu'il n'y a pas d'erreurs Docusaurus ou de Markdown.
93+
2. **Construire le site :** Tenter de générer une version complète du site pour s'assurer qu'il n'y a pas de liens cassés ou d'erreurs de build.
94+
95+
🚨 **Votre PR ne sera pas validée tant que les vérifications de la CI/CD ne sont pas au vert (✅).** Si la CI échoue, veuillez consulter les logs pour corriger le problème avant de repousser vos modifications.
96+
97+
## ✅ Validation Finale
98+
99+
Une fois que la CI/CD a réussi, les mainteneurs du dépôt AyLabs (Aymeric ou un modérateur) examineront votre code.
100+
101+
* Si des changements mineurs sont nécessaires, un commentaire sera laissé sur la PR.
102+
* Si tout est conforme, votre contribution sera **fusionnée** (merged) dans la branche principale !
103+
104+
Merci encore pour votre aide et votre soutien au projet AyLabs !

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) [Année de création] [Votre Nom/Nom de l'organisation (ex: AyLabs)]
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 69 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,84 @@
1-
# Website
1+
# 🏠 Docs AyLabs : Documentation Domotique & Homelab Communautaire
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3+
[![GitHub](https://img.shields.io/github/license/AyLabsCode/docs?style=for-the-badge)](./LICENSE)
4+
[![GitHub contributors](https://img.shields.io/github/contributors/AyLabsCode/docs?style=for-the-badge)](https://github.com/AyLabsCode/docs/graphs/contributors)
5+
[![Docusaurus V2](https://img.shields.io/badge/Made%20with-Docusaurus%20v2-blue?style=for-the-badge)](https://docusaurus.io/)
46

5-
## Installation
7+
Bienvenue sur le dépôt officiel des documentations **AyLabs** ! Ce site a pour vocation de devenir la ressource de référence, centralisée et communautaire, pour tous les passionnés de **Domotique** et de **Homelab**.
68

7-
```bash
8-
yarn
9-
```
9+
## 🎯 Objectifs du Projet
1010

11-
## Local Development
11+
Notre but est de fournir des guides, des astuces et des configurations toujours à jour, grâce à l'effort collectif.
1212

13-
```bash
14-
yarn start
15-
```
13+
* **Centralisation :** Regrouper toutes les connaissances de la chaîne AyLabs et de la communauté en un seul endroit facile d'accès.
14+
* **Open Source :** Chaque article, chaque tutoriel est modifiable. La transparence est notre mot d'ordre.
15+
* **Actualité Garantie :** Fini les guides obsolètes ! Le modèle communautaire garantit une mise à jour rapide lorsque les technologies évoluent.
1616

17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
17+
---
1818

19-
## Build
19+
## 🛠️ Comment Contribuer ?
2020

21-
```bash
22-
yarn build
23-
```
21+
Ces documentations vivent grâce à vous. Si vous détectez une erreur, si un outil a été mis à jour, ou si vous avez une meilleure méthode, votre contribution est essentielle !
2422

25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
23+
### 1. 🐛 Signaler un Problème
2624

27-
## Deployment
25+
Si vous trouvez une erreur, un lien cassé, ou une information manquante, veuillez ouvrir une [Issue GitHub](https://github.com/AyLabs/docs-repo/issues/new/choose) pour le signaler.
2826

29-
Using SSH:
27+
### 2. ✍️ Proposer une Modification (Pull Request)
3028

31-
```bash
32-
USE_SSH=true yarn deploy
33-
```
29+
Vous souhaitez ajouter un nouveau guide ou corriger/améliorer un article existant ? Suivez ces étapes simples :
3430

35-
Not using SSH:
31+
1. **Forkez** ce dépôt.
32+
2. Clonez votre fork en local.
33+
3. Créez une nouvelle branche pour votre modification : `git checkout -b ma-super-contribution`.
34+
4. Effectuez vos modifications (les fichiers de documentation se trouvent principalement dans le dossier `docs/`).
35+
5. **Testez en local** (voir la section ci-dessous).
36+
6. Commitez vos changements et pushez-les sur votre fork.
37+
7. Ouvrez une **Pull Request** vers la branche `main` de ce dépôt.
3638

37-
```bash
38-
GIT_USER=<Your GitHub username> yarn deploy
39-
```
39+
Nous examinerons votre proposition dans les plus brefs délais !
4040

41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
41+
---
42+
43+
## 🧑‍💻 Démarrer le Projet en Local
44+
45+
Pour visualiser la documentation ou tester vos contributions avant de soumettre une PR, vous pouvez lancer le site Docusaurus en local.
46+
47+
### Prérequis
48+
49+
* Node.js (version 18 ou supérieure recommandée)
50+
* Yarn ou npm
51+
52+
### Installation et Lancement
53+
54+
1. **Cloner le dépôt :**
55+
```bash
56+
git clone https://github.com/AyLabsCode/docs
57+
cd docs
58+
```
59+
60+
2. **Installer les dépendances :**
61+
```bash
62+
yarn install
63+
# ou
64+
npm install
65+
```
66+
67+
3. **Lancer le serveur de développement :**
68+
```bash
69+
yarn start
70+
# ou
71+
npm start
72+
```
73+
74+
Le site sera accessible à l'adresse `http://localhost:3000`. Toute modification des fichiers sources (dans `docs/` ou `src/`) sera automatiquement rechargée.
75+
76+
---
77+
78+
## 📄 Licence
79+
80+
Ce projet est distribué sous licence **MIT**. Voir le fichier [LICENSE](./LICENSE) pour plus d'informations.
81+
82+
---
83+
84+
**Un grand merci à tous les contributeurs qui font vivre cette documentation !**
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
2-
"label": "⚙️ Configuration avancée",
3-
"position": 3,
2+
"label": "Avancé",
3+
"position": 4,
44
"link": {
55
"type": "generated-index",
66
"description": "Une fois Home Assistant installé, c'est parti pour la configuration !"
77
}
8-
}
8+
}
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
import YouTube from '@site/src/components/YouTube';
6+
7+
# Automatisations
8+
Les automatisations dans Home Assistant vous permettent de créer des scénarios personnalisés pour automatiser le comportement de vos appareils connectés. Voici comment les configurer et les optimiser. 🤖
9+
10+
C'est grâce aux automatisations que vous pourrez relier des appareils qui normalement ne communiquent pas ensemble, ou encore créer des scénarios avancés en fonction de conditions spécifiques (heure, état d'un capteur, etc.).
11+
Voici des idées d'automatisations courantes, possibles lorsque vous maîtrisez bien le concept :
12+
- Allumer les lumières du salon lorsque vous arrivez à la maison après le coucher du soleil ☀️
13+
- Envoyer une notification lorsque la porte d'entrée est ouverte entre 22h et 6h 📲
14+
- Régler le thermostat en fonction de la météo extérieure 🌡️
15+
- Activer une scène d'éclairage spécifique lorsque vous lancez votre film préféré 🎬
16+
17+
## Créer une automatisation simple 🤖
18+
<YouTube videoId="gbyNcv_Tl6A" />
19+
20+
Le système d'automatisations intégré de Home Assistant est très puissant et permet de créer des automatisations simples en quelques clics.
21+
22+
## Node-RED ⚙️
23+
<YouTube videoId="d1s9VAD1ClM" />
24+
25+
Node-RED est une plateforme de programmation visuelle qui permet de créer des automatisations complexes dans Home Assistant à l'aide d'une interface graphique.
26+
Il est particulièrement utile pour les utilisateurs avancés qui souhaitent aller au-delà des capacités d'automatisation intégrées de Home Assistant.
27+
Gardez à l'esprit que l'installation et la configuration de Node-RED peuvent nécessiter des connaissances techniques supplémentaires.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
import YouTube from '@site/src/components/YouTube';
6+
7+
# Dashboards
8+
Les tableaux de bord dans Home Assistant vous permettent de visualiser et de contrôler vos appareils connectés
9+
et automatisations de manière personnalisée. Voici comment les configurer et les optimiser. 📊
10+
11+
## Création d'un dashboard complet 🎨
12+
J'avais fait une vidéo complète sur la création d'un dashboard personnalisé dans Home Assistant.
13+
[Cet article](https://aylabs.fr/video/mon-dashboard-sur-home-assistant) détaillait les étapes principales, mais pour une compréhension approfondie, je vous recommande de regarder la vidéo ci-dessous
14+
15+
<YouTube videoId="GBd8ngtlAbA" />
16+
17+
## Génération d'un dashboard automatique ⚡
18+
Pour ceux qui préfèrent une approche plus rapide, Home Assistant propose une fonctionnalité de génération automatique de dashboards basée sur vos appareils et entités existants.
19+
Il est également possible de générer un dashboard avec [Linus Dashboard](https://github.com/Thank-you-Linus/Linus-Dashboard), une solution française qui permet de générer vos dashboards automatiquement avec un rendu très propre.
20+
<YouTube videoId="T5vjP3gI1Zw" />
21+
22+
## Ressources supplémentaires
23+
- [📹 Vidéo par Zatoufly (Août 2024)](https://www.youtube.com/watch?v=Xbdju2eLy20)
24+
- [📹 Vidéo par Howmation (Avril 2024)](https://www.youtube.com/watch?v=h-ikQ8G6YWk)
25+
- [📹 Vidéo par DomoTech (Juillet 2023)](https://www.youtube.com/watch?v=-ApdURkkVFU)
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
sidebar_position: 5
3+
---
4+
5+
import YouTube from '@site/src/components/YouTube';
6+
7+
# Gestion des tâches ménagères
8+
La gestion des poubelles et du tri des déchets peut être facilitée grâce à Home Assistant. Voici quelques idées pour automatiser et organiser cette tâche ménagère essentielle. 🗑️
9+
10+
<YouTube videoId="UQ9OAEBx6Ho" />

0 commit comments

Comments
 (0)