.gitignore

@@ -0,0 +1,162 @@
+# ---> Python
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+

.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
+

0.1/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.

0.1/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)
+

0.1/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)
+

0.1/docs/guide_utilisateur/02_outils.md

@@ -0,0 +1,6 @@
+# Barre ou menu d'outils
+
+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`.
+
+Selon le produit, une page par groupe d'outils, avec si besoin des sous-niveaux. 

0.1/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`.

0.1/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`.

0.1/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
+...
+
+
+
+
+

0.1/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.

0.1/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)
+
+
+
+
+
+

0.1/docs/guides_techniques/administrer/une_page.md

@@ -0,0 +1,7 @@
+# Une page
+
+
+Une page de la partie "Administrer"
+
+
+

0.1/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)
+
+
+
+

0.1/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`.

0.1/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 ?
+
+
+
+

0.1/docs/guides_techniques/index.md

@@ -0,0 +1,7 @@
+# Index des guides techniques
+
+## Sommaire
+
+sommaire
+
+

0.1/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 

0.1/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.

0.1/docs/guides_techniques/installer/02_preparation.md

@@ -0,0 +1,3 @@
+# Préparation
+
+Comment préparer les prérequis

0.1/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

0.1/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

0.1/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

0.1/docs/guides_techniques/installer/06_tests.md

@@ -0,0 +1,5 @@
+# Tests
+
+Vérification que tout est fonctionnel
+
+Indication de la page de status ?

0.1/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)
+

0.1/docs/guides_techniques/installer/une_page.md

@@ -0,0 +1,7 @@
+# Une page
+
+
+Une page de la partie "Administrer"
+
+
+

0.1/docs/index.md

@@ -0,0 +1,17 @@
+# Accueil
+
+## C'est quoi ?
+
+Le composant Mon composant permet de faire la fonctionnalité XXXX.
+
+</br>
+
+![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

0.1/docs/tableofcontent.md

@@ -0,0 +1,46 @@
+<!-- ====================== TOC ====================== -->
+<!-- Generated by mkdocs-toc-md plugin -->
+<!-- ================================================= -->
+
+
+
+# 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](guide_utilisateur\02_outils.md#barre-ou-menu-doutils)
+## [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)