{"config":{"lang":["fr"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Accueil","text":""},{"location":"#cest-quoi","title":"C'est quoi ?","text":"<p>Le composant Mon composant permet de faire la fonctionnalit\u00e9 XXXX.</p> <p></p> <p></p> <p>Freepik</p> <p>Je sais faire / Je sais PAS faire (p\u00e9rim\u00e8tre fonctionnel)</p> <p>le pitch exemples + liens</p>"},{"location":"tableofcontent/","title":"Tableofcontent","text":""},{"location":"tableofcontent/#contents","title":"Contents","text":"<p>Summary of the section</p>"},{"location":"tableofcontent/#sommaire-du-guide-utilisateur","title":"Sommaire du guide utilisateur","text":""},{"location":"tableofcontent/#prendre-en-main-rapidement","title":"Prendre en main rapidement","text":""},{"location":"tableofcontent/#vue-globale","title":"Vue globale","text":""},{"location":"tableofcontent/#barre-ou-menu-doutils","title":"Barre ou menu d'outils","text":""},{"location":"tableofcontent/#index-des-guides-techniques","title":"Index des guides techniques","text":""},{"location":"tableofcontent/#sommaire","title":"Sommaire","text":""},{"location":"tableofcontent/#sommaire_1","title":"Sommaire","text":""},{"location":"tableofcontent/#une-page","title":"Une page","text":""},{"location":"tableofcontent/#sommaire_2","title":"Sommaire","text":""},{"location":"tableofcontent/#presentation","title":"Pr\u00e9sentation","text":"<ul> <li>Architecture composant</li> <li>Recommandation</li> </ul>"},{"location":"tableofcontent/#prerequis","title":"Pr\u00e9requis","text":"<ul> <li>Mat\u00e9riel</li> <li>Logiciel</li> </ul>"},{"location":"tableofcontent/#preparation","title":"Pr\u00e9paration","text":""},{"location":"tableofcontent/#installation","title":"Installation","text":""},{"location":"tableofcontent/#configuration","title":"Configuration","text":""},{"location":"tableofcontent/#debug","title":"Debug","text":"<ul> <li>Debug</li> <li>Log</li> </ul>"},{"location":"tableofcontent/#tests","title":"Tests","text":""},{"location":"tableofcontent/#presentation_1","title":"Pr\u00e9sentation","text":""},{"location":"tableofcontent/#architecture-composant","title":"Architecture composant","text":""},{"location":"tableofcontent/#recommandation","title":"Recommandation","text":""},{"location":"tableofcontent/#prerequis_1","title":"Pr\u00e9requis","text":""},{"location":"tableofcontent/#materiel","title":"Mat\u00e9riel","text":""},{"location":"tableofcontent/#logiciel","title":"Logiciel","text":""},{"location":"tableofcontent/#preparation_1","title":"Pr\u00e9paration","text":""},{"location":"tableofcontent/#installation_1","title":"Installation","text":""},{"location":"tableofcontent/#configuration_1","title":"Configuration","text":""},{"location":"tableofcontent/#debug_1","title":"Debug","text":""},{"location":"tableofcontent/#debug_2","title":"Debug","text":""},{"location":"tableofcontent/#log","title":"Log","text":""},{"location":"tableofcontent/#tests_1","title":"Tests","text":""},{"location":"tableofcontent/#sommaire_3","title":"Sommaire","text":""},{"location":"tableofcontent/#matrice-des-fonctionnalites","title":"Matrice des fonctionnalit\u00e9s","text":""},{"location":"tableofcontent/#documentation-de-lapi","title":"Documentation de l'API","text":""},{"location":"guide_utilisateur/","title":"Sommaire du guide utilisateur","text":"<p>Cette page est d\u00e9di\u00e9e au sommaire du guide utilisateur du composant, c'est-\u00e0-dire \u00e0 la documentation de r\u00e9f\u00e9rence qui d\u00e9crit toutes les fonctionnalit\u00e9s et outils du composant \u00e0 destination des utilisateurs. La table des mati\u00e8res pour le guide est int\u00e9gr\u00e9e ici.</p> <p>Recommandations:</p> <ul> <li>Apr\u00e8s cette page, commencer par une partie \"Vue globale\" de l'outil qui pr\u00e9sente la fen\u00eatre principale du composant.</li> <li>Ajouter un maximum de captures d'\u00e9cran pour illustrer. Les images sont stock\u00e9es dans le r\u00e9pertoire <code>images</code>.</li> </ul> <p>Exemple d'arborescence du guide pour Mapstore2 :</p> <ul> <li>Vue globale du composant</li> <li>G\u00e9rer les param\u00e8tres des couches</li> <li>La table attributaire</li> <li>La barre de menus</li> <li>Imprimer une carte ...</li> </ul>"},{"location":"guide_utilisateur/00_prise_en_main/","title":"Prendre en main rapidement","text":"<p>Documentation assez courte sur la mani\u00e8re de s'y retrouver tr\u00e8s rapidement dans le produit (en quelques clics), en focalisant sur les fonctionnalit\u00e9s essentielles, pour ne pas perdre des utilisateurs d\u00e9butants ou peu \u00e0 l'aise avec ce type d'outil.</p> <p>Si possible mettre des images et/ou sch\u00e9mas pour all\u00e9ger visuellement, voire mettre une vid\u00e9o tutoriel.</p>"},{"location":"guide_utilisateur/00_vue_globale/","title":"Vue globale","text":"<p>Vue globale de la page qui appara\u00eet lorsque l'on ouvre le composant.</p> <p>Exemple pour Mapstore :</p> <p></p>"},{"location":"guide_utilisateur/01_vue_globale/","title":"Vue globale","text":"<p>Vue globale de la page qui appara\u00eet lorsque l'on ouvre le produit, avec encards ou num\u00e9ros localisant et nommant les diff\u00e9rents outils d\u00e9crits dans les diff\u00e9rentes parties.</p> <p>Exemple de vue globale Mapstore2 :</p> <p></p>"},{"location":"guide_utilisateur/02_outils/","title":"Barre ou menu d'outils","text":"<p>Pr\u00e9sentation d'un premier ensemble d'outils, avec captures d'\u00e9cran \u00e0 l'appui le plus souvent possible pour ne pas perdre l'utilisateur. Les images sont stock\u00e9es dans le r\u00e9pertoire <code>images</code>.</p> <p>Selon le produit, une page par groupe d'outils, avec si besoin des sous-niveaux. </p>"},{"location":"guide_utilisateur/02_outils_1/","title":"Barre ou menu d'outils 1","text":"<p>Pr\u00e9sentation d'un premier ensemble d'outils, avec captures d'\u00e9cran \u00e0 l'appui le plus souvent possible pour ne pas perdre l'utilisateur. Les images sont stock\u00e9es dans le r\u00e9pertoire <code>images</code>.</p>"},{"location":"guide_utilisateur/03_outils_2/","title":"Barre ou menu d'outils 2","text":"<p>Pr\u00e9sentation d'un second ensemble d'outils, avec captures d'\u00e9cran \u00e0 l'appui le plus souvent possible pour ne pas perdre l'utilisateur. Les images sont stock\u00e9es dans le r\u00e9pertoire <code>images</code>.</p>"},{"location":"guide_utilisateur/prise_en_main/","title":"Prendre en main rapidement","text":"<p>Documentation assez courte sur la mani\u00e8re de s'y retrouver tr\u00e8s rapidement dans le composant (en quelques clics), en focalisant sur les fonctionnalit\u00e9s essentielles, pour ne pas perdre des utilisateurs d\u00e9butants ou peu \u00e0 l'aise avec ce type d'outil.</p> <p>Si possible mettre des images et/ou sch\u00e9mas pour all\u00e9ger visuellement, voire mettre une vid\u00e9o tutoriel.</p>"},{"location":"guides_techniques/","title":"Index des guides techniques","text":""},{"location":"guides_techniques/#sommaire","title":"Sommaire","text":"<p>sommaire</p>"},{"location":"guides_techniques/administrer/","title":"Sommaire","text":"<p>Sommaire de la partie Administrer</p> <p>Cette partie de la documentation est d\u00e9di\u00e9e \u00e0 l'administration du contenu:</p> <ul> <li>gestion des donn\u00e9es,</li> <li>mise \u00e0 jour des donn\u00e9es</li> <li>gestion des utilisateurs</li> <li>...</li> </ul> <p>Mettre les images dans le r\u00e9pertoire imgages</p> <p></p>"},{"location":"guides_techniques/administrer/une_page/","title":"Une page","text":"<p>Une page de la partie \"Administrer\"</p>"},{"location":"guides_techniques/developper/","title":"Sommaire","text":"<p>Sommaire de la partie \"D\u00e9velopper\"</p> <p></p> <p>Voici ce qui est attendu comme documentation pour cette partie :</p> <ul> <li>d\u00e9crire la s\u00e9paration entre la partie client et la partie serveur</li> <li>donner les URL vers les API</li> <li>d\u00e9crire les m\u00e9thodes des API (sauf si swagger int\u00e9gr\u00e9)</li> <li>matrice des fonctionnalit\u00e9s</li> </ul> <p>Si cela est possible et pertinent : documenter la cr\u00e9ation ou l'utilisation d'un mod\u00e8le (template) de d\u00e9veloppement utilisant le composant.</p> <p>Les images sont stok\u00e9es dans le r\u00e9pertoire <code>images</code>.</p>"},{"location":"guides_techniques/developper/api/","title":"Documentation de l'API","text":"<ul> <li>donner les URL vers les API</li> <li>d\u00e9crire les m\u00e9thodes des API (sauf si swagger int\u00e9gr\u00e9 -&gt; url vers le swagger)</li> </ul>"},{"location":"guides_techniques/developper/matrice_fonctionnalites/","title":"Matrice des fonctionnalit\u00e9s","text":"<p>D\u00e9crire ici la liste des fonctionnalit\u00e9s, sous la forme de tableau si possible ?</p>"},{"location":"guides_techniques/installer/","title":"Sommaire","text":"<p>Sommaire de la partie Installer</p>"},{"location":"guides_techniques/installer/#presentation","title":"Pr\u00e9sentation","text":""},{"location":"guides_techniques/installer/#architecture-composant","title":"Architecture composant","text":""},{"location":"guides_techniques/installer/#recommandation","title":"Recommandation","text":""},{"location":"guides_techniques/installer/#prerequis","title":"Pr\u00e9requis","text":""},{"location":"guides_techniques/installer/#materiel","title":"Mat\u00e9riel","text":""},{"location":"guides_techniques/installer/#logiciel","title":"Logiciel","text":""},{"location":"guides_techniques/installer/#preparation","title":"Pr\u00e9paration","text":""},{"location":"guides_techniques/installer/#installation","title":"Installation","text":""},{"location":"guides_techniques/installer/#configuration","title":"Configuration","text":""},{"location":"guides_techniques/installer/#debug","title":"Debug","text":""},{"location":"guides_techniques/installer/#debug_1","title":"Debug","text":""},{"location":"guides_techniques/installer/#log","title":"Log","text":""},{"location":"guides_techniques/installer/#tests","title":"Tests","text":""},{"location":"guides_techniques/installer/00_presentation/","title":"Pr\u00e9sentation","text":""},{"location":"guides_techniques/installer/00_presentation/#architecture-composant","title":"Architecture composant","text":"<p>Pr\u00e9sentation de la hi\u00e9rarchie du composant</p>"},{"location":"guides_techniques/installer/00_presentation/#recommandation","title":"Recommandation","text":"<p>Recommandation sur l'architecture de l'installation </p>"},{"location":"guides_techniques/installer/01_prerequis/","title":"Pr\u00e9requis","text":""},{"location":"guides_techniques/installer/01_prerequis/#materiel","title":"Mat\u00e9riel","text":"<p>5 Go de ram, 2 cpu, 10Go disques, etc.</p>"},{"location":"guides_techniques/installer/01_prerequis/#logiciel","title":"Logiciel","text":"<p>Indiquer les d\u00e9pendances \u00e0 des librairies ou logiciels.</p>"},{"location":"guides_techniques/installer/02_preparation/","title":"Pr\u00e9paration","text":"<p>Comment pr\u00e9parer les pr\u00e9requis</p>"},{"location":"guides_techniques/installer/03_installation/","title":"Installation","text":"<p>Comment installer le composant:</p> <ul> <li>git clonne / t\u00e9l\u00e9charge les binaires</li> <li>installer les dependances/librairie requise</li> <li>d\u00e9marrer une d\u00e9mo avec configuration par d\u00e9faut</li> </ul>"},{"location":"guides_techniques/installer/04_configuration/","title":"Configuration","text":"<p>Comment configurer le composant:</p> <ul> <li>explication des diff\u00e9rentes brique de configuration (ou et quoi)</li> <li>liste des configurations possible</li> <li>exemple avec des cas concret, je veux faire \u00e7a avec la r\u00e9ponse</li> </ul>"},{"location":"guides_techniques/installer/05_debug/","title":"Debug","text":""},{"location":"guides_techniques/installer/05_debug/#debug_1","title":"Debug","text":"<p>Comment obtenir du debug (+plus d'information dans la console ?)</p>"},{"location":"guides_techniques/installer/05_debug/#log","title":"Log","text":"<p>Comment son construit les logs</p> <p>Ou sont il stocker par default (ou envoy\u00e9 \u00e0 distance)</p> <p>Comment modifier la localisation/cible distante</p>"},{"location":"guides_techniques/installer/06_tests/","title":"Tests","text":"<p>V\u00e9rification que tout est fonctionnel</p> <p>Indication de la page de status ?</p>"},{"location":"guides_techniques/installer/une_page/","title":"Une page","text":"<p>Une page de la partie \"Administrer\"</p>"}]}