doc: synchronize scaffolding with georchestra template's

georchestra · Feb 5, 2025 · bcc227a · bcc227a
1 parent 9c7018a
commit bcc227a
Show file tree

Hide file tree

Showing 55 changed files with 332 additions and 103 deletions.
diff --git a/docs/guides_techniques/administrer/3d.md b/docs/guides_techniques/administrer/3d.md
diff --git a/docs/guides_techniques/installer/index.md b/docs/guides_techniques/installer/index.md
diff --git a/docs/guides_techniques/installer/une_page.md b/docs/guides_techniques/installer/une_page.md
diff --git a/docs/index.en.md b/docs/index.en.md
@@ -0,0 +1,19 @@
+---
+hide:
+  - navigation
+  - toc
+---
+
+# Home
+
+## What is it ?
+
+This componant can do.... pancakes !
+
+</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)
+
+
diff --git a/docs/index.md → docs/index.fr.md b/docs/index.md → docs/index.fr.md
diff --git a/docs/guide_utilisateur/images/alire.txt → ...al_guides/administration/images/alire.txt b/docs/guide_utilisateur/images/alire.txt → ...al_guides/administration/images/alire.txt
diff --git a/...es/administrer/images/gestion_donnees.jpg → ...administration/images/gestion_donnees.jpg b/...es/administrer/images/gestion_donnees.jpg → ...administration/images/gestion_donnees.jpg
diff --git a/docs/technical_guides/administration/index.en.md b/docs/technical_guides/administration/index.en.md
@@ -0,0 +1,14 @@
+# Table of Contents
+
+Table of Contents for the Administration Section
+
+This section of the documentation is dedicated to content administration:
+
+- Data Management
+- Data Updates
+- User Management
+- ...
+
+Place images in the `images` directory.
+
+![Data Management](images/gestion_donnees.jpg)
diff --git a/docs/guides_techniques/administrer/index.md → ...chnical_guides/administration/index.fr.md b/docs/guides_techniques/administrer/index.md → ...chnical_guides/administration/index.fr.md
diff --git a/docs/technical_guides/administration/one_page.en.md b/docs/technical_guides/administration/one_page.en.md
@@ -0,0 +1,3 @@
+# A Page
+
+A page from the "Administration" section.
diff --git a/...guides_techniques/administrer/une_page.md → ...ical_guides/administration/one_page.fr.md b/...guides_techniques/administrer/une_page.md → ...ical_guides/administration/one_page.fr.md
diff --git a/docs/technical_guides/contribute/api.en.md b/docs/technical_guides/contribute/api.en.md
@@ -0,0 +1,4 @@
+# API Documentation
+
+- Provide URLs to the APIs.
+- Describe the methods of the APIs (unless Swagger is integrated -> URL to Swagger).
diff --git a/docs/guides_techniques/developper/api.md → docs/technical_guides/contribute/api.fr.md b/docs/guides_techniques/developper/api.md → docs/technical_guides/contribute/api.fr.md
diff --git a/docs/technical_guides/contribute/feature_matrix.en.md b/docs/technical_guides/contribute/feature_matrix.en.md
@@ -0,0 +1,3 @@
+# Feature Matrix
+
+Describe here the list of features, ideally in the form of a table.
diff --git a/...ues/developper/matrice_fonctionnalites.md → ...al_guides/contribute/feature_matrix.fr.md b/...ues/developper/matrice_fonctionnalites.md → ...al_guides/contribute/feature_matrix.fr.md
diff --git a/...s_techniques/administrer/images/alire.txt → ...hnical_guides/contribute/images/alire.txt b/...s_techniques/administrer/images/alire.txt → ...hnical_guides/contribute/images/alire.txt
diff --git a/...chniques/developper/images/developper.jpg → ...l_guides/contribute/images/developper.jpg b/...chniques/developper/images/developper.jpg → ...l_guides/contribute/images/developper.jpg
diff --git a/docs/technical_guides/contribute/index.en.md b/docs/technical_guides/contribute/index.en.md
@@ -0,0 +1,16 @@
+# Table of Contents
+
+Table of Contents for the "Develop" Section
+
+![Develop](images/developper.jpg)
+
+Here's what is expected for documentation in this section:
+
+- Describe the separation between the client and server parts.
+- Provide URLs to the APIs.
+- Describe the methods of the APIs (unless Swagger is integrated).
+- Feature matrix.
+
+If possible and relevant: document the creation or use of a development template using the component.
+
+Images are stored in the `images` directory.
diff --git a/docs/guides_techniques/developper/index.md → docs/technical_guides/contribute/index.fr.md b/docs/guides_techniques/developper/index.md → docs/technical_guides/contribute/index.fr.md
diff --git a/...es_techniques/developper/images/alire.txt → docs/technical_guides/images/alire.txt b/...es_techniques/developper/images/alire.txt → docs/technical_guides/images/alire.txt
diff --git a/docs/technical_guides/index.en.md b/docs/technical_guides/index.en.md
@@ -0,0 +1,5 @@
+# Technical Guides Index
+
+## Table of Contents
+
+Table of contents.
diff --git a/docs/guides_techniques/index.md → docs/technical_guides/index.fr.md b/docs/guides_techniques/index.md → docs/technical_guides/index.fr.md
diff --git a/docs/technical_guides/installation/configuration.en.md b/docs/technical_guides/installation/configuration.en.md
@@ -0,0 +1,7 @@
+# Configuration
+
+How to configure the component:
+
+- Explanation of the different configuration components (where and what).
+- List of possible configurations.
+- Example with concrete cases: I want to achieve this with the response.
diff --git a/..._techniques/installer/04_configuration.md → ...l_guides/installation/configuration.fr.md b/..._techniques/installer/04_configuration.md → ...l_guides/installation/configuration.fr.md
diff --git a/docs/technical_guides/installation/debug.en.md b/docs/technical_guides/installation/debug.en.md
@@ -0,0 +1,13 @@
+# Debugging
+
+## Debugging
+
+How to obtain debugging information (additional information in the console)?
+
+## Logging
+
+How are logs constructed?
+
+Where are they stored by default (or sent remotely)?
+
+How to modify the location/remote target?
diff --git a/docs/guides_techniques/installer/05_debug.md → ...technical_guides/installation/debug.fr.md b/docs/guides_techniques/installer/05_debug.md → ...technical_guides/installation/debug.fr.md
diff --git a/docs/guides_techniques/images/alire.txt → ...ical_guides/installation/images/alire.txt b/docs/guides_techniques/images/alire.txt → ...ical_guides/installation/images/alire.txt
diff --git a/docs/technical_guides/installation/index.en.md b/docs/technical_guides/installation/index.en.md
@@ -0,0 +1,21 @@
+# Table of Contents
+
+Table of Contents for the "Install" Section
+
+
+
+## [Presentation](presentation.md#presentation)
+### [Component Architecture](presentation.md#component-architecture)
+### [Recommendation](presentation.md#recommendation)
+## [Prerequisites](prerequisites.md#prerequis)
+### [Hardware](prerequisites.md#materiel)
+### [Software](prerequisites.md#logiciel)
+## [Preparation](preparation.md#preparation)
+## [Installation](installation.md#installation)
+## [Configuration](configuration.md#configuration)
+## [Debugging](debug.md#debug)
+### [Debugging](debug.md#debug_1)
+### [Logging](debug.md#log)
+## [Testing](tests.md#tests)
+
+
diff --git a/docs/technical_guides/installation/index.fr.md b/docs/technical_guides/installation/index.fr.md
@@ -0,0 +1,21 @@
+# Sommaire
+
+
+Sommaire de la partie Installer
+
+
+
+## [Présentation](presentation.md#presentation)
+### [Architecture composant](presentation.md#architecture-composant)
+### [Recommandation](presentation.md#recommandation)
+## [Prérequis](prerequisites.md#prerequis)
+### [Matériel](prerequisites.md#materiel)
+### [Logiciel](prerequisites.md#logiciel)
+## [Préparation](preparation.md#preparation)
+## [Installation](installation.md#installation)
+## [Configuration](configuration.md#configuration)
+## [Debug](debug.md#debug)
+### [Debug](debug.md#debug_1)
+### [Log](debug.md#log)
+## [Tests](tests.md#tests)
+
diff --git a/docs/technical_guides/installation/installation.en.md b/docs/technical_guides/installation/installation.en.md
@@ -0,0 +1,7 @@
+# Installation
+
+How to install the component:
+
+- Clone/download from git or download binaries.
+- Install required dependencies/libraries.
+- Start a demo with default configuration.
diff --git a/...s_techniques/installer/03_installation.md → ...al_guides/installation/installation.fr.md b/...s_techniques/installer/03_installation.md → ...al_guides/installation/installation.fr.md
diff --git a/docs/technical_guides/installation/preparation.en.md b/docs/technical_guides/installation/preparation.en.md
@@ -0,0 +1,3 @@
+# Preparation
+
+How to prepare the prerequisites.
diff --git a/...es_techniques/installer/02_preparation.md → ...cal_guides/installation/preparation.fr.md b/...es_techniques/installer/02_preparation.md → ...cal_guides/installation/preparation.fr.md
diff --git a/docs/technical_guides/installation/prerequisites.en.md b/docs/technical_guides/installation/prerequisites.en.md
@@ -0,0 +1,9 @@
+# Prerequisites
+
+## Hardware
+
+5 GB RAM, 2 CPUs, 10 GB disk space, etc.
+
+## Software
+
+List the dependencies on libraries or software.
diff --git a/...ides_techniques/installer/01_prerequis.md → ...l_guides/installation/prerequisites.fr.md b/...ides_techniques/installer/01_prerequis.md → ...l_guides/installation/prerequisites.fr.md
diff --git a/docs/technical_guides/installation/presentation.en.md b/docs/technical_guides/installation/presentation.en.md
@@ -0,0 +1,9 @@
+# Presentation
+
+## Component Architecture
+
+Introduction to the component hierarchy.
+
+## Recommendation
+
+Recommendation on the installation architecture.
diff --git a/...s_techniques/installer/00_presentation.md → ...al_guides/installation/presentation.fr.md b/...s_techniques/installer/00_presentation.md → ...al_guides/installation/presentation.fr.md
diff --git a/docs/technical_guides/installation/tests.en.md b/docs/technical_guides/installation/tests.en.md
@@ -0,0 +1,5 @@
+# Testing
+
+Verification that everything is functional.
+
+Indication of the status page?
diff --git a/docs/guides_techniques/installer/06_tests.md → ...technical_guides/installation/tests.fr.md b/docs/guides_techniques/installer/06_tests.md → ...technical_guides/installation/tests.fr.md
diff --git a/docs/user_guide/getting_started.en.md b/docs/user_guide/getting_started.en.md
@@ -0,0 +1,5 @@
+# Getting Started Quickly
+
+A relatively short documentation on how to quickly get acquainted with the product (in a few clicks), focusing on essential features, to avoid losing beginner users or those who are not comfortable with this type of tool.
+
+If possible, include images and/or diagrams to visually lighten the content, or even include a tutorial video.
diff --git a/docs/guide_utilisateur/00_prise_en_main.md → docs/user_guide/getting_started.fr.md b/docs/guide_utilisateur/00_prise_en_main.md → docs/user_guide/getting_started.fr.md
diff --git a/docs/user_guide/global_overview.en.md b/docs/user_guide/global_overview.en.md
@@ -0,0 +1,7 @@
+# Global Overview
+
+An overview of the page that appears when the product is opened, with boxes or numbers indicating and naming the different tools described in the various sections.
+
+Example of Mapstore2 global overview:
+
+![](images/00_vue_globale.png)
diff --git a/docs/guide_utilisateur/01_vue_globale.md → docs/user_guide/global_overview.fr.md b/docs/guide_utilisateur/01_vue_globale.md → docs/user_guide/global_overview.fr.md
diff --git a/...ide_utilisateur/images/00_vue_globale.png → docs/user_guide/images/00_vue_globale.png b/...ide_utilisateur/images/00_vue_globale.png → docs/user_guide/images/00_vue_globale.png
diff --git a/...des_techniques/installer/images/alire.txt → docs/user_guide/images/alire.txt b/...des_techniques/installer/images/alire.txt → docs/user_guide/images/alire.txt
diff --git a/...e_utilisateur/images/georchestra-logo.svg → docs/user_guide/images/georchestra-logo.svg b/...e_utilisateur/images/georchestra-logo.svg → docs/user_guide/images/georchestra-logo.svg
diff --git a/docs/user_guide/index.en.md b/docs/user_guide/index.en.md
@@ -0,0 +1,22 @@
+# User guide index
+
+This page is dedicated to the summary of the component's user guide, that is to say the reference documentation which describes all the functionalities and tools of the component intended for **users**.
+The table of contents for the guide is embedded here.
+
+**Recommendations**:
+
+- After this page, start with a "Global View" part of the tool which presents the main window of the component.
+- Add as many screenshots as possible to illustrate. Images are stored in the `images` directory.
+
+Example of guide tree for Mapstore2:
+
+- Global view of the component
+- Manage layer settings
+- The attribute table
+- The menu bar
+- Print a card
+...
+
+
+
+
diff --git a/docs/guide_utilisateur/index.md → docs/user_guide/index.fr.md b/docs/guide_utilisateur/index.md → docs/user_guide/index.fr.md
diff --git a/docs/user_guide/syntax_help.en.md b/docs/user_guide/syntax_help.en.md
@@ -0,0 +1,57 @@
+# Syntax Help
+
+This page is here to help writers get acquainted with the markdown syntax itself enhanced by mkdocs and its plugins.
+
+Refer to [this site](https://www.markdownguide.org/basic-syntax/) for more comprehensive examples of Markdown syntax.
+
+
+
+## Headings and Hierarchy
+
+
+## Images
+
+Place images in the `images` directory at the same level as the markdown file.
+
+`![georchestra logo](images/georchestra-logo.svg)`
+
+![georchestra logo](images/georchestra-logo.svg)
+
+
+
+## Links
+
+
+## Notes, Warnings
+
+To obtain specific blocks to draw the reader's attention, you need to:
+
+- Install the Python module `mkdocs-callouts`
+- In the `mkdocs.yml` file: add `markdown_extensions` and a `plugin` (default declared)
+
+See [https://squidfunk.github.io/mkdocs-material/reference/admonitions/](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) for more information.
+
+Examples below, check the markdown file for the source code.
+
+
+!!! note "Note"
+
+    Logoden biniou welcome. December or huzh. Some specific number. Ler ugent ma. Meurzh understanding koll. Dreuz Egineg an. An kas gortoz. C’higer mouezh Gerveur. Nor ur alies. Drezoc'h gwengolo kuzuliañ.
+
+    Mestr kemmañ talvezout. Anezhañ kenavo tasenn. Neud laezh tarv. Warnomp an bleun. Vuoc’h da Plouneour-Menez. Bouton votez ac’hano. Huñvre c’hof poazhañ. Da pevar muiañ. Doñjer gouel alc’houez. Pluenn siminal hed.
+
+
+
+!!! tip "Tip"
+
+    Logoden biniou welcome. December or huzh. Some specific number. Ler ugent ma. Meurzh understanding koll. Dreuz Egineg an. An kas gortoz. C’higer mouezh Gerveur. Nor ur alies. Drezoc'h gwengolo kuzuliañ.
+
+    Mestr kemmañ talvezout. Anezhañ kenavo tasenn. Neud laezh tarv. Warnomp an bleun. Vuoc’h da Plouneour-Menez. Bouton votez ac’hano. Huñvre c’hof poazhañ. Da pevar muiañ. Doñjer gouel alc’houez. Pluenn siminal hed.
+
+
+!!! warning "Warning"
+
+    Logoden biniou welcome. December or huzh. Some specific number. Ler ugent ma. Meurzh understanding koll. Dreuz Egineg an. An kas gortoz. C’higer mouezh Gerveur. Nor ur alies. Drezoc'h gwengolo kuzuliañ.
+
+    Mestr kemmañ talvezout. Anezhañ kenavo tasenn. Neud laezh tarv. Warnomp an bleun. Vuoc’h da Plouneour-Menez. Bouton votez ac’hano. Huñvre c’hof poazhañ. Da pevar muiañ. Doñjer gouel alc’houez. Pluenn siminal hed.
+
diff --git a/docs/guide_utilisateur/aide_syntaxe.md → docs/user_guide/syntax_help.fr.md b/docs/guide_utilisateur/aide_syntaxe.md → docs/user_guide/syntax_help.fr.md
diff --git a/docs/user_guide/tools.en.md b/docs/user_guide/tools.en.md
@@ -0,0 +1,6 @@
+# Toolbar or Menu
+
+Introduction to a first set of tools, often accompanied by screenshots to guide the user effectively.
+Images are stored in the `images` directory.
+
+Depending on the product, there may be a page for each group of tools, with sub-levels if necessary.
diff --git a/docs/guide_utilisateur/02_outils.md → docs/user_guide/tools.fr.md b/docs/guide_utilisateur/02_outils.md → docs/user_guide/tools.fr.md
diff --git a/mkdocs-requirements.txt b/mkdocs-requirements.txt
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# A Page

		A page from the "Administration" section.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Feature Matrix

		Describe here the list of features, ideally in the form of a table.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Preparation

		How to prepare the prerequisites.