diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..02b9292 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,26 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# seul le HTML en ligne est supporté par MKDocs +# formats: +# - pdf + + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.9" + +mkdocs: + configuration: mkdocs.yml + +# Optionally declare the Python requirements required to build your docs +python: + install: + - requirements: requirements.txt + diff --git a/docs/css/extra.css b/docs/css/extra.css new file mode 100644 index 0000000..c2b5134 --- /dev/null +++ b/docs/css/extra.css @@ -0,0 +1,22 @@ + + +:root { + --md-primary-fg-color:#85127e; + --md-primary-fg-color--light:#85127e; + --md-primary-fg-color--dark:#85127e; + --md-primary-bg-color:#fff; + --md-primary-bg-color--light:#ffffffb3; + --md-accent-fg-color:#526cfe; + --md-accent-fg-color--transparent:#526cfe1a; + --md-accent-bg-color:#fff; + --md-accent-bg-color--light:#ffffffb3 +} + +h1, h2, h3 { + color:rgb(133, 18, 126)!important; + font-weight:600!important; +} + +footer { + background-color: #500b4c!important; +} \ No newline at end of file diff --git a/docs/guide_utilisateur/00_prise_en_main.md b/docs/guide_utilisateur/00_prise_en_main.md new file mode 100644 index 0000000..4c127aa --- /dev/null +++ b/docs/guide_utilisateur/00_prise_en_main.md @@ -0,0 +1,5 @@ +# Prendre en main rapidement + +Documentation assez courte sur la manière de s'y retrouver très rapidement dans le produit (en quelques clics), en focalisant sur les fonctionnalités essentielles, pour ne pas perdre des utilisateurs débutants ou peu à l'aise avec ce type d'outil. + +Si possible mettre des images et/ou schémas pour alléger visuellement, voire mettre une vidéo tutoriel. diff --git a/docs/guide_utilisateur/00_vue_globale.md b/docs/guide_utilisateur/00_vue_globale.md new file mode 100644 index 0000000..c8f47cf --- /dev/null +++ b/docs/guide_utilisateur/00_vue_globale.md @@ -0,0 +1,8 @@ +# Vue globale + +Vue globale de la page qui apparaît lorsque l'on ouvre le composant. + +Exemple pour Mapstore : + +![](/docs/guide_utilisateur/images/vue_globale.PNG) + diff --git a/docs/guide_utilisateur/01_vue_globale.md b/docs/guide_utilisateur/01_vue_globale.md new file mode 100644 index 0000000..8fbd367 --- /dev/null +++ b/docs/guide_utilisateur/01_vue_globale.md @@ -0,0 +1,8 @@ +# Vue globale + +Vue globale de la page qui apparaît lorsque l'on ouvre le produit, avec encards ou numéros localisant et nommant les différents outils décrits dans les différentes parties. + +Exemple de vue globale Mapstore2 : + +![](/images/00_vue_globale.PNG) + diff --git a/docs/guide_utilisateur/02_outils_1.md b/docs/guide_utilisateur/02_outils_1.md new file mode 100644 index 0000000..9908058 --- /dev/null +++ b/docs/guide_utilisateur/02_outils_1.md @@ -0,0 +1,4 @@ +# Barre ou menu d'outils 1 + +Présentation d'un premier ensemble d'outils, avec captures d'écran à l'appui le plus souvent possible pour ne pas perdre l'utilisateur. +Les images sont stockées dans le répertoire `images`. \ No newline at end of file diff --git a/docs/guide_utilisateur/03_outils_2.md b/docs/guide_utilisateur/03_outils_2.md new file mode 100644 index 0000000..fc0ac6a --- /dev/null +++ b/docs/guide_utilisateur/03_outils_2.md @@ -0,0 +1,4 @@ +# Barre ou menu d'outils 2 + +Présentation d'un second ensemble d'outils, avec captures d'écran à l'appui le plus souvent possible pour ne pas perdre l'utilisateur. +Les images sont stockées dans le répertoire `images`. \ No newline at end of file diff --git a/docs/guide_utilisateur/images/00_vue_globale.png b/docs/guide_utilisateur/images/00_vue_globale.png new file mode 100644 index 0000000..407b3aa Binary files /dev/null and b/docs/guide_utilisateur/images/00_vue_globale.png differ diff --git a/docs/guide_utilisateur/images/alire.txt b/docs/guide_utilisateur/images/alire.txt new file mode 100644 index 0000000..1b57127 --- /dev/null +++ b/docs/guide_utilisateur/images/alire.txt @@ -0,0 +1 @@ +dossier image \ No newline at end of file diff --git a/docs/guide_utilisateur/index.md b/docs/guide_utilisateur/index.md new file mode 100644 index 0000000..23098dd --- /dev/null +++ b/docs/guide_utilisateur/index.md @@ -0,0 +1,23 @@ +# Sommaire du guide utilisateur + +Cette page est dédiée au sommaire du guide utilisateur du composant, c'est-à-dire à la documentation de référence qui décrit toutes les fonctionnalités et outils du composant à destination des **utilisateurs**. +La table des matières pour le guide est intégrée ici. + +**Recommandations**: + +- Après cette page, commencer par une partie "Vue globale" de l'outil qui présente la fenêtre principale du composant. +- Ajouter un maximum de captures d'écran pour illustrer. Les images sont stockées dans le répertoire `images`. + +Exemple d'arborescence du guide pour Mapstore2 : + +- Vue globale du composant +- Gérer les paramètres des couches +- La table attributaire +- La barre de menus +- Imprimer une carte +... + + + + + diff --git a/docs/guide_utilisateur/prise_en_main.md b/docs/guide_utilisateur/prise_en_main.md new file mode 100644 index 0000000..bbde2c7 --- /dev/null +++ b/docs/guide_utilisateur/prise_en_main.md @@ -0,0 +1,5 @@ +# Prendre en main rapidement + +Documentation assez courte sur la manière de s'y retrouver très rapidement dans le composant (en quelques clics), en focalisant sur les fonctionnalités essentielles, pour ne pas perdre des utilisateurs débutants ou peu à l'aise avec ce type d'outil. + +Si possible mettre des images et/ou schémas pour alléger visuellement, voire mettre une vidéo tutoriel. diff --git a/docs/guides_techniques/administrer/images/alire.txt b/docs/guides_techniques/administrer/images/alire.txt new file mode 100644 index 0000000..1b57127 --- /dev/null +++ b/docs/guides_techniques/administrer/images/alire.txt @@ -0,0 +1 @@ +dossier image \ No newline at end of file diff --git a/docs/guides_techniques/administrer/images/gesiton_donnees.jpg b/docs/guides_techniques/administrer/images/gesiton_donnees.jpg new file mode 100644 index 0000000..0e17458 Binary files /dev/null and b/docs/guides_techniques/administrer/images/gesiton_donnees.jpg differ diff --git a/docs/guides_techniques/administrer/index.md b/docs/guides_techniques/administrer/index.md new file mode 100644 index 0000000..6f35d41 --- /dev/null +++ b/docs/guides_techniques/administrer/index.md @@ -0,0 +1,24 @@ +# Sommaire + + +Sommaire de la partie Administrer + +Cette partie de la documentation est dédiée à l'administration du contenu: + + +- gestion des données, +- mise à jour des données +- gestion des utilisateurs +- ... + + +Mettre les images dans le répertoire imgages + + +![](./images/gesiton_donnees.jpg) + + + + + + diff --git a/docs/guides_techniques/administrer/une_page.md b/docs/guides_techniques/administrer/une_page.md new file mode 100644 index 0000000..de5b5ce --- /dev/null +++ b/docs/guides_techniques/administrer/une_page.md @@ -0,0 +1,7 @@ +# Une page + + +Une page de la partie "Administrer" + + + diff --git a/docs/guides_techniques/developper/api.md b/docs/guides_techniques/developper/api.md new file mode 100644 index 0000000..6ef0a48 --- /dev/null +++ b/docs/guides_techniques/developper/api.md @@ -0,0 +1,9 @@ +# Documentation de l'API + + +- donner les URL vers les API +- décrire les méthodes des API (sauf si swagger intégré -> url vers le swagger) + + + + diff --git a/docs/guides_techniques/developper/images/alire.txt b/docs/guides_techniques/developper/images/alire.txt new file mode 100644 index 0000000..1b57127 --- /dev/null +++ b/docs/guides_techniques/developper/images/alire.txt @@ -0,0 +1 @@ +dossier image \ No newline at end of file diff --git a/docs/guides_techniques/developper/images/developper.jpg b/docs/guides_techniques/developper/images/developper.jpg new file mode 100644 index 0000000..64a3434 Binary files /dev/null and b/docs/guides_techniques/developper/images/developper.jpg differ diff --git a/docs/guides_techniques/developper/index.md b/docs/guides_techniques/developper/index.md new file mode 100644 index 0000000..fe4b936 --- /dev/null +++ b/docs/guides_techniques/developper/index.md @@ -0,0 +1,17 @@ +# Sommaire + +Sommaire de la partie "Développer" + +![](images/developper.jpg) + +Voici ce qui est attendu comme documentation pour cette partie : + +- décrire la séparation entre la partie client et la partie serveur +- donner les URL vers les API +- décrire les méthodes des API (sauf si swagger intégré) +- matrice des fonctionnalités + +Si cela est possible et pertinent : documenter la création ou l'utilisation d'un modèle (template) de développement utilisant le composant. + + +Les images sont stokées dans le répertoire `images`. \ No newline at end of file diff --git a/docs/guides_techniques/developper/matrice_fonctionnalites.md b/docs/guides_techniques/developper/matrice_fonctionnalites.md new file mode 100644 index 0000000..5d94fe2 --- /dev/null +++ b/docs/guides_techniques/developper/matrice_fonctionnalites.md @@ -0,0 +1,8 @@ +# Matrice des fonctionnalités + + +Décrire ici la liste des fonctionnalités, sous la forme de tableau si possible ? + + + + diff --git a/docs/guides_techniques/images/alire.txt b/docs/guides_techniques/images/alire.txt new file mode 100644 index 0000000..1b57127 --- /dev/null +++ b/docs/guides_techniques/images/alire.txt @@ -0,0 +1 @@ +dossier image \ No newline at end of file diff --git a/docs/guides_techniques/index.md b/docs/guides_techniques/index.md new file mode 100644 index 0000000..ef926d5 --- /dev/null +++ b/docs/guides_techniques/index.md @@ -0,0 +1,7 @@ +# Index des guides techniques + +## Sommaire + +sommaire + + diff --git a/docs/guides_techniques/installer/00_presentation.md b/docs/guides_techniques/installer/00_presentation.md new file mode 100644 index 0000000..35b272e --- /dev/null +++ b/docs/guides_techniques/installer/00_presentation.md @@ -0,0 +1,12 @@ +# Présentation + +## Architecture composant + +Présentation de la hiérarchie du composant + + + + +## Recommandation + +Recommandation sur l'architecture de l'installation \ No newline at end of file diff --git a/docs/guides_techniques/installer/01_prerequis.md b/docs/guides_techniques/installer/01_prerequis.md new file mode 100644 index 0000000..e46d902 --- /dev/null +++ b/docs/guides_techniques/installer/01_prerequis.md @@ -0,0 +1,10 @@ +# Prérequis + +## Matériel + +5 Go de ram, 2 cpu, 10Go disques, etc. + + +## Logiciel + +Indiquer les dépendances à des librairies ou logiciels. diff --git a/docs/guides_techniques/installer/02_preparation.md b/docs/guides_techniques/installer/02_preparation.md new file mode 100644 index 0000000..d6e9ef8 --- /dev/null +++ b/docs/guides_techniques/installer/02_preparation.md @@ -0,0 +1,3 @@ +# Préparation + +Comment préparer les prérequis \ No newline at end of file diff --git a/docs/guides_techniques/installer/03_installation.md b/docs/guides_techniques/installer/03_installation.md new file mode 100644 index 0000000..e2228c2 --- /dev/null +++ b/docs/guides_techniques/installer/03_installation.md @@ -0,0 +1,7 @@ +# Installation + +Comment installer le composant: + +- git clonne / télécharge les binaires +- installer les dependances/librairie requise +- démarrer une démo avec configuration par défaut diff --git a/docs/guides_techniques/installer/04_configuration.md b/docs/guides_techniques/installer/04_configuration.md new file mode 100644 index 0000000..b972f87 --- /dev/null +++ b/docs/guides_techniques/installer/04_configuration.md @@ -0,0 +1,7 @@ +# Configuration + +Comment configurer le composant: + +- explication des différentes brique de configuration (ou et quoi) +- liste des configurations possible +- exemple avec des cas concret, je veux faire ça avec la réponse diff --git a/docs/guides_techniques/installer/05_debug.md b/docs/guides_techniques/installer/05_debug.md new file mode 100644 index 0000000..493998f --- /dev/null +++ b/docs/guides_techniques/installer/05_debug.md @@ -0,0 +1,13 @@ +# Debug + +## Debug + +Comment obtenir du debug (+plus d'information dans la console ?) + +## Log + +Comment son construit les logs + +Ou sont il stocker par default (ou envoyé à distance) + +Comment modifier la localisation/cible distante \ No newline at end of file diff --git a/docs/guides_techniques/installer/06_tests.md b/docs/guides_techniques/installer/06_tests.md new file mode 100644 index 0000000..18c379e --- /dev/null +++ b/docs/guides_techniques/installer/06_tests.md @@ -0,0 +1,5 @@ +# Tests + +Vérification que tout est fonctionnel + +Indication de la page de status ? \ No newline at end of file diff --git a/docs/guides_techniques/installer/images/alire.txt b/docs/guides_techniques/installer/images/alire.txt new file mode 100644 index 0000000..1b57127 --- /dev/null +++ b/docs/guides_techniques/installer/images/alire.txt @@ -0,0 +1 @@ +dossier image \ No newline at end of file diff --git a/docs/guides_techniques/installer/index.md b/docs/guides_techniques/installer/index.md new file mode 100644 index 0000000..f64626b --- /dev/null +++ b/docs/guides_techniques/installer/index.md @@ -0,0 +1,21 @@ +# Sommaire + + +Sommaire de la partie Installer + + + +## [Présentation](guides_techniques/installer/00_presentation.md#presentation) +### [Architecture composant](guides_techniques/installer/00_presentation.md#architecture-composant) +### [Recommandation](guides_techniques/installer/00_presentation.md#recommandation) +## [Prérequis](guides_techniques/installer/01_prerequis.md#prerequis) +### [Matériel](guides_techniques/installer/01_prerequis.md#materiel) +### [Logiciel](guides_techniques/installer/01_prerequis.md#logiciel) +## [Préparation](guides_techniques/installer/02_preparation.md#preparation) +## [Installation](guides_techniques/installer/03_installation.md#installation) +## [Configuration](guides_techniques/installer/04_configuration.md#configuration) +## [Debug](guides_techniques/installer/05_debug.md#debug) +### [Debug](guides_techniques/installer/05_debug.md#debug_1) +### [Log](guides_techniques/installer/05_debug.md#log) +## [Tests](guides_techniques/installer/06_tests.md#tests) + diff --git a/docs/guides_techniques/installer/une_page.md b/docs/guides_techniques/installer/une_page.md new file mode 100644 index 0000000..de5b5ce --- /dev/null +++ b/docs/guides_techniques/installer/une_page.md @@ -0,0 +1,7 @@ +# Une page + + +Une page de la partie "Administrer" + + + diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico new file mode 100644 index 0000000..69fa00c Binary files /dev/null and b/docs/images/favicon.ico differ diff --git a/docs/images/georchestra-logo-white.svg b/docs/images/georchestra-logo-white.svg new file mode 100644 index 0000000..e9bd3e4 --- /dev/null +++ b/docs/images/georchestra-logo-white.svg @@ -0,0 +1,104 @@ + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/images/joyeux-collegues-utilisant-ordinateurs-portables.jpg b/docs/images/joyeux-collegues-utilisant-ordinateurs-portables.jpg new file mode 100644 index 0000000..9667eb6 Binary files /dev/null and b/docs/images/joyeux-collegues-utilisant-ordinateurs-portables.jpg differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..7301491 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,17 @@ +# Accueil + +## C'est quoi ? + +Cette page sert simplement de test de la documentation geOrchestra. + +
+ +![image info](./images/joyeux-collegues-utilisant-ordinateurs-portables.jpg) + +[Freepik](https://fr.freepik.com/photos-gratuite/joyeux-collegues-utilisant-ordinateurs-portables_2317379.htm#query=people%20working%20office) + + +Je sais faire / Je sais PAS faire (périmètre fonctionnel) + +le pitch +exemples + liens diff --git a/docs/tableofcontent.md b/docs/tableofcontent.md new file mode 100644 index 0000000..a1499c2 --- /dev/null +++ b/docs/tableofcontent.md @@ -0,0 +1,47 @@ + + + + + + +# Contents +Summary of the section +## [Sommaire du guide utilisateur](guide_utilisateur\index.md#sommaire-du-guide-utilisateur) +## [Prendre en main rapidement](guide_utilisateur\00_prise_en_main.md#prendre-en-main-rapidement) +## [Vue globale](guide_utilisateur\01_vue_globale.md#vue-globale) +## [Barre ou menu d'outils 1](guide_utilisateur\02_outils_1.md#barre-ou-menu-doutils-1) +## [Barre ou menu d'outils 2](guide_utilisateur\03_outils_2.md#barre-ou-menu-doutils-2) +## [Index des guides techniques](guides_techniques\index.md#index-des-guides-techniques) +### [Sommaire](guides_techniques\index.md#sommaire) +## [Sommaire](guides_techniques\administrer\index.md#sommaire) +## [Une page](guides_techniques\administrer\une_page.md#une-page) +## [Sommaire](guides_techniques\installer\index.md#sommaire) +### [Présentation](guides_techniques\installer\index.md#presentation) +* [Architecture composant](guides_techniques\installer\index.md#architecture-composant) +* [Recommandation](guides_techniques\installer\index.md#recommandation) +### [Prérequis](guides_techniques\installer\index.md#prerequis) +* [Matériel](guides_techniques\installer\index.md#materiel) +* [Logiciel](guides_techniques\installer\index.md#logiciel) +### [Préparation](guides_techniques\installer\index.md#preparation) +### [Installation](guides_techniques\installer\index.md#installation) +### [Configuration](guides_techniques\installer\index.md#configuration) +### [Debug](guides_techniques\installer\index.md#debug) +* [Debug](guides_techniques\installer\index.md#debug_1) +* [Log](guides_techniques\installer\index.md#log) +### [Tests](guides_techniques\installer\index.md#tests) +## [Présentation](guides_techniques\installer\00_presentation.md#presentation) +### [Architecture composant](guides_techniques\installer\00_presentation.md#architecture-composant) +### [Recommandation](guides_techniques\installer\00_presentation.md#recommandation) +## [Prérequis](guides_techniques\installer\01_prerequis.md#prerequis) +### [Matériel](guides_techniques\installer\01_prerequis.md#materiel) +### [Logiciel](guides_techniques\installer\01_prerequis.md#logiciel) +## [Préparation](guides_techniques\installer\02_preparation.md#preparation) +## [Installation](guides_techniques\installer\03_installation.md#installation) +## [Configuration](guides_techniques\installer\04_configuration.md#configuration) +## [Debug](guides_techniques\installer\05_debug.md#debug) +### [Debug](guides_techniques\installer\05_debug.md#debug_1) +### [Log](guides_techniques\installer\05_debug.md#log) +## [Tests](guides_techniques\installer\06_tests.md#tests) +## [Sommaire](guides_techniques\developper\index.md#sommaire) +## [Matrice des fonctionnalités](guides_techniques\developper\matrice_fonctionnalites.md#matrice-des-fonctionnalites) +## [Documentation de l'API](guides_techniques\developper\api.md#documentation-de-lapi) diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..b73d500 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,82 @@ +site_name: Test de documentation d'un composant geOrchestra - 20230209 + +repo_url: https://gitea.datagrandest.net/guillaume_ryckelynck/georchestra_documentation_module_test +repo_name: georchestra_documentation_module_test + +docs_dir: docs +edit_uri: edit/main/docs/ + +theme: + language: fr + features: + - toc.integrate + - navigation.indexes + - navigation.tabs + - navigation.tabs.sticky + - navigation.footer + logo: images/georchestra-logo-white.svg + favicon: images/favicon.ico + name: material + +extra: + generator: false + social: + - icon: fontawesome/solid/paper-plane + link: mailto:psc@georchestra.org + - icon: fontawesome/brands/twitter + link: https://twitter.com/georchestra + - icon: fontawesome/brands/github + link: https://github.com/georchestra +copyright: '© 2023 - georchestra' + +extra_css: + - css/extra.css + +# arborescence de 1er et 2e niveau à gérer ici +# Ces entrées correspondent au modèle de documentation + +nav: + - Accueil: index.md + - Guide utilisateur: + - Sommaire: guide_utilisateur/index.md + - Prendre en main: guide_utilisateur/00_prise_en_main.md + - Utiliser: + - guide_utilisateur/01_vue_globale.md + - guide_utilisateur/02_outils_1.md + - guide_utilisateur/03_outils_2.md + - Guides techniques: + - Sommaire: guides_techniques/index.md + - Administrer: + - guides_techniques/administrer/index.md + - guides_techniques/administrer/une_page.md + - Installer: + - guides_techniques/installer/index.md + - guides_techniques/installer/00_presentation.md + - guides_techniques/installer/01_prerequis.md + - guides_techniques/installer/02_preparation.md + - guides_techniques/installer/03_installation.md + - guides_techniques/installer/04_configuration.md + - guides_techniques/installer/05_debug.md + - guides_techniques/installer/06_tests.md + - Développer: + - guides_techniques/developper/index.md + - guides_techniques/developper/matrice_fonctionnalites.md + - guides_techniques/developper/api.md +plugins: + - search + - toc-md: + toc_page_title: Contents + toc_page_description: Summary of the section + header_level: 3 + pickup_description_meta: false + pickup_description_class: false + output_path: tableofcontent.md + output_log: true + ignore_page_pattern: index.md + remove_navigation_page_pattern: index.md + template_dir_path: custom_template + - git-revision-date-localized: + enable_creation_date: true + + +# TODO Documenter comment simplifier l'arborescence pour un petit projet diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..bca2ec6 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,37 @@ +Babel==2.11.0 +beautifulsoup4==4.11.2 +certifi==2022.12.7 +charset-normalizer==3.0.1 +click==8.1.3 +colorama==0.4.6 +ghp-import==2.1.0 +gitdb==4.0.10 +GitPython==3.1.30 +html5lib==1.1 +idna==3.4 +importlib-metadata==6.0.0 +Jinja2==3.1.2 +Markdown==3.3.7 +MarkupSafe==2.1.2 +mergedeep==1.3.4 +mkdocs==1.4.2 +mkdocs-git-revision-date-localized-plugin==1.1.0 +mkdocs-material==9.0.11 +mkdocs-material-extensions==1.1.1 +mkdocs-toc-md==0.0.4 +packaging==23.0 +Pygments==2.14.0 +pymdown-extensions==9.9.2 +python-dateutil==2.8.2 +pytz==2022.7.1 +PyYAML==6.0 +pyyaml_env_tag==0.1 +regex==2022.10.31 +requests==2.28.2 +six==1.16.0 +smmap==5.0.0 +soupsieve==2.3.2.post1 +urllib3==1.26.14 +watchdog==2.2.1 +webencodings==0.5.1 +zipp==3.12.1