Documentation Mautic
Introduction
Ce guide fait office de documentation pour Mautic, le logiciel de marketing automation open source. Le code étant libre d'accès à chacun, en voici sa documentation. Chacun peut contribuer à rendre ces informations de meilleure qualité.
Télécharger la documentation en PDF
Cliquez ici pour téélcharger ce document en PDF.
Comment contribuer à la documentation
Ce repository est le lieux ou est stocké la documentation sous forme de Gitbook publié sur www.mautic.org/docs. La source du code est partagée sur GitHub afin que chacun puisse contribuer de la même manière que les développeurs contribuent pour le code de l'application Mautic.
Pourquoi nous utilisons git pour la documentation
- versions. Chacun peut regarder dans le passer et voir comment le texte était.
- authorship. Chaque ligne a un auteur identifié.
- community contributions. Nous travaillons tous sur le même document, pas de risque d'avoir d'impact négatif pour notre travail communautaire.
Ainsi, quelques connaissances en git sont requises pour cloner, modifier, commiter et envoyer les modifications. Vous pouvez éviter cela en utilisant l'interface web de GitHub. Si vous connaissez git, procédez comme vous le souhaitez.
Modifier un document dans votre navigateur
- Faites un Fork du repository sur votre compt afin d'avoir les droits d'édition.
- Sélectionnez un fichir à éditer. La structure du fichier est expliquée ci dessous. Maintenant, éditons le fichier README.md pour en voir le principe. Cliquez sur celui ci.
- Le contenu du README.md devrait être visible et le bouton Edit (icon de stylo). Cliquez dessus.
- Le contenu est écrit en Markdown markup. Format de mise en forme de texte très simple.
- Faites une modification sur le fichier. Par exemple, ajoutez à la fin
Ceci est ma premièe contribution. - Quand vous faites une modification, descendez et constatez le bouton Commit changes. Ceci est important. Pour sauvegarder des modifications, vous devez décrire ce que vous avez changé et pourquoi. Par exemple
Une nouvelle ligne ajoutée dans un but de test. Ne sauvegardez pas maintenant ! - L'interface GitHub web ne vous donne pas accès à toutes les fonctionnalités de git, et il sera compliqué de revenir en arrière après votre modification. Il faudrait créer un nouveau commit pour modifier votre modification précédente. Ca rendrait l'historique un peu compliqué. Du coup, créons une nouvelle branche. Il y a une case à cocher "Créer une nouvelle branche...". Vous devez donner un nom à cette branche.
{yourusername}-patch-1sera pré-rempli. Changez le par{yourusername}-testingpar exemple. Cliquez sur Propose file change maintenant. - Voici, le changement existe dans votre clone. Pour propose ce changement au repository officiel, vous devez faire une pull request (PR). Vous avez normalement été redirigé pou faire cela. Décrivez ici votre proposition de changement et cliquez (ne le faits pas pour tester s'il vous plait) sur le bouton Create pull request.
La structure du fichier
Nous avons travaillé sur le fichier README.md. Ce fichier est affiché sur la page d'accueil du repository GitHub et vous êtes en train d'en lire son contenu en ce moment même.
Le fichier SUMMARY.md gère le menu de la documentation.
Les dossiers regroupent des sujets similaires.
Liens
Pour faire un lien en Markdown, procédez ainsi :
[link title](http://example.com)
Cela créera un lien externe. Si vous voulez faire des liens relatifs :
[these steps](./../plugins/integration_test.html)
Images
Vous pouvez stocker des images dans les dossiers assets et puis vous pouvez les afficher dans les pages de la manière suivante :
ou avec des liens relatifs.