Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correction de la documentation #155

Open
wants to merge 40 commits into
base: master
Choose a base branch
from
Open

Correction de la documentation #155

wants to merge 40 commits into from

Conversation

MrWaloo
Copy link
Contributor

@MrWaloo MrWaloo commented Dec 19, 2024

Correction de la documentation

Description

Correction de la documentation

Suggested changelog entry

Correction de la documentation

Related issues/external references

Fixes #

Types of changes

  • Bug fix (non-breaking change which fixes)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
    • This change is only breaking for integrators, not for external standards or end-users.
  • Documentation improvement

PR checklist

@MrWaloo
Copy link
Contributor Author

MrWaloo commented Dec 21, 2024

Je vais pousser un commit avec la correction des liens et tout mettre en lien relatif, c'était plus simple pour moi et les liens sont plus courts en terme de lisibilité on y gagne

C'est plus simple signifie que mon fork fonctionne en "local" et j'ai pu tester les liens sans toujours aller vers la doc officielle.

@MrWaloo
Copy link
Contributor Author

MrWaloo commented Jan 18, 2025

Bonjour,
Pourquoi ces modifications ne sont-elles pas mergées ? Il manque quelque chose ?
J'ai passé un temps de dingue et je trouverais dommage que ces corrections soient perdues. Bien sûr je suis ouvert aux critiques et suis disposé à corriger ce qui ne va pas.

@@ -30,7 +30,7 @@ Comme pour le core Jeedom, la documentation des plugins officiels est automatiqu

>**IMPORTANT**
>
>A lire impérativement avant toute intervention : [**Comment contribuer au développement du core Jeedom ?**](https://doc.jeedom.com/fr_FR/contribute/core)
>A lire impérativement avant toute intervention : [**Comment contribuer au développement du core Jeedom ?**](contribute/core)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
>A lire impérativement avant toute intervention : [**Comment contribuer au développement du core Jeedom ?**](contribute/core)
>À lire impérativement avant toute intervention : [**Comment contribuer au développement du core Jeedom ?**](contribute/core)

Et j'ai un doute concernant le lien.
Est-ce qu'il ne serait pas plus interessant de l'indiquer depuis la root /fr_FR/contribute/...
C'est censé fonctionner et ca serait plus propre selon moi.

Copy link
Contributor Author

@MrWaloo MrWaloo Jan 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dans ce cas, oui tout à fait.
Merci

@@ -60,7 +60,7 @@ En version **Beta** et **Alpha**, les changements sont beaucoup plus fréquents

### Changelog

Dès le début du développement de la version **Alpha**, l'équipe essaye de tenir à jour le futur [Changelog](/fr_FR/core/4.5/changelog). Les nouveautés pouvant évoluer fortement voir être supprimées ou reportées, celui-ci n'est donc pas forcément à jour et n'a pas valeur de référence.
Dès le début du développement de la version **Alpha**, l'équipe essaye de tenir à jour le futur [Changelog](../core/4.5/changelog). Les nouveautés pouvant évoluer fortement voir être supprimées ou reportées, celui-ci n'est donc pas forcément à jour et n'a pas valeur de référence.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Du coup je constate que tu utilises les chemins relatifs. Y a une raison particulière a cette préférence ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oui, sur mon fork, les liens pointent vers le fork et pas vers la source du fork

Hardware | Etat | Remarques
--- | --- | ---
Hardware | Etat | Remarques
---------------- | ------------- | ----------

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

| Docker | | Beta | root/Mjeedom96 | | [Docker](https://doc.jeedom.com/fr_FR/installation/docker) |
| Freebox | Freebox Delta | Stable | root/Mjeedom96 | A installer directement depuis la Freebox | [Freebox](https://doc.jeedom.com/fr_FR/installation/freeboxdelta) |
| Synology (Docker)| Nas Synology | Beta | root/Mjeedom96 | | [Synology](https://doc.jeedom.com/fr_FR/installation/synology) |
| Images | Hardware | Etat | Accès SSH | Remarques | Documentations |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

État

@@ -51,7 +51,7 @@ Sur le même principe que la documentation du Core, celle des plugins est récup

Par exemple, pour le plugin OpenZWave

- Accès à la doc ici : https://doc.jeedom.com/fr_FR/plugins/automation%20protocol/openzwave/
- Accès à la doc ici : ../plugins/automation%20protocol/openzwave/

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Peut-être mettre sous forme de lien

@@ -233,7 +233,7 @@ Il existe des déclencheurs spécifiques (autre que ceux fournis par les command
- ``#end_restore#`` : Événement envoyé à la fin d’une restauration.
- ``#user_connect#`` : Connexion d'un utilisateur

Vous pouvez aussi déclencher un scénario quand une variable est mise à jour en mettant : #variable(nom_variable)# ou en utilisant l’API HTTP décrite [ici](https://doc.jeedom.com/fr_FR/core/4.1/api_http).
Vous pouvez aussi déclencher un scénario quand une variable est mise à jour en mettant : #variable(nom_variable)# ou en utilisant l’API HTTP décrite [ici](../4.1/api_http).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pour le #variable(nom_variable)#, on peut rajouter des backquotes `` ca donnerai #variable(nom_variable)#

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Je n'ai pas touché aux versions < 4.5
Pour la 4.5, c'est le cas. (c'était déjà le cas)

@@ -1,7 +1,7 @@
# Interactions
**Outils → Interactions**

Le système d’interactions dans Jeedom permet de réaliser des actions à partir de commandes textes ou vocales.
Dans Jeedom le système d’interactions permet de réaliser des actions à partir de commandes textes ou vocales.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Dans Jeedom le système d’interactions permet de réaliser des actions à partir de commandes textes ou vocales.
Dans Jeedom, le système d’interactions permet de réaliser des actions à partir de commandes textes ou vocales.


Celle-ci se décompose en plusieurs parties :

## Mon profil

Cest ici que vous allez pouvoir régler différents paramètres de votre profil :
C'est ici que vous allez pouvoir régler différents paramètres de votre profil :

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Je comprend la modif, mais j'en profite pour faire une remarque : tu viens de remplacer le caractère correct pour une apostrophe par une quote. Et c'est bien dommage que très peu de perzonnes ne le sache.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sur mon clavier (ch_DE) je n'ai que ce caractère...

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Je te rassure, en azerty aussi il n'existe pas. C'était juste une remarque général, aucunement une critique et c'est même la "norme" ce caractère.


Vous pouvez aussi à partir de cet onglet entrer un code promo (un code pour un plugin par exemple que le développeur a pu vous transmettre) et faire un don.
A partir de cet onglet, vous pouvez aussi entrer un code promo (par exemple un code pour un plugin que le développeur a pu vous transmettre) et faire un don.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

À

@MrWaloo
Copy link
Contributor Author

MrWaloo commented Feb 11, 2025

Franchement, ce serait dommage de perdre ces corrections.

@Salvialf
Copy link
Contributor

Franchement, ce serait dommage de perdre ces corrections.

Tout à fait!

Nous avons de nombreuses contributions à évaluer pour l'ensemble de Jeedom, pour être tout à fait transparent lorsque cette prolifique contribution a été abordée plusieurs interrogations ont été émises quant au passage des liens en relatif.

D'une manière générale il est toujours préférable de diviser de gros commits en plusieurs requêtes pour plus de lisibilité et de facilité de mise en production.

@MrWaloo
Copy link
Contributor Author

MrWaloo commented Feb 14, 2025

J'ai juste actualisé mon dépôt sans modification (volontaire)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants