📝 [Documentation] Reorganize sections in doc

[bruhnild]

Description

Related Issue

Checklist

• I have followed the guidelines in our Contributing document
• My code respects the Definition of done available in the Development section of the documentation
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have added tests that prove my fix is effective or that my feature works.
• New and existing unit tests pass locally with my changes
• I added an entry in the changelog file
• My commits are all using prefix convention (emoji + tag name) and references associated issues
• I added a label to the PR corresponding to the perimeter of my contribution
• The title of my PR mentionned the issue associated

[bruhnild]

• Issue liée : Réorganisation de la doc #4415
• Lien de la doc pour tester : https://geotrek.readthedocs.io/en/mfu-improve-doc-gta/

[camillemonchicourt]

C'est bien d'avoir regroupé tout ce qui concerne l'import.
Mais par contre, on comprend moins ce qui est lié à l'import initial des données minimales pour avoir un Geotrek fonctionnel dans la foulée de son installation. Et ce qui concerne l'import de données complémentaires ou en continu, au fil du projet.
A voir comment préciser/clarifier ça.
J'essaie de relire plus en détail dès que possible.

[babastienne]

on comprend moins ce qui est lié à l'import initial des données minimales pour avoir un Geotrek fonctionnel dans la foulée de son installation

Peut-être ajouter à la fin de la page d'installation une mention "Une fois votre Geotrek installer, il faut importer des données initiales" (avec un lien vers la page dédiée)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.46%. Comparing base (fe60cf0) to head (377aac5).
Report is 17 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #4424   +/-   ##
=======================================
  Coverage   98.46%   98.46%           
=======================================
  Files         268      268           
  Lines       21290    21290           
=======================================
  Hits        20964    20964           
  Misses        326      326           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[cypress]

Geotrek-admin    Run #10727

Run Properties:   Passed #10727  •  84a0843803 ℹ️: Merge 377aac58cd36efc83c7c959e649f06e33f62ba9a into 4dba2fb8f4dbf97c182d9c27228f...

Project	Geotrek-admin
Branch Review	refs/pull/4424/merge
Run status	Passed #10727
Run duration	02m 04s
Commit	84a0843803 ℹ️: Merge 377aac58cd36efc83c7c959e649f06e33f62ba9a into 4dba2fb8f4dbf97c182d9c27228f...
Committer	Marine Faucher
View all properties for this run ↗︎

---

Test results
Failures	0
Flaky	0
Pending	0
Skipped	0
Passing	22
View all changes introduced in this branch ↗︎

[babastienne]

Sur certaines pages il y a des titres de section qui sont "bizarres"

C'est déjà le cas aujourd'hui mais ça pourrait être corrigé au passage

[camillemonchicourt]

Pour moi, ces données sont les données initiales minimales (Minimal initial data), donc à préciser dans le titre ou dans un petit texte, surtout maintenant que c'est déplacé plus bas dans la documentation.

[bruhnild]

C'est fait, il y a désormais un message en base de la page Installation qui renvoie vers la page Prerequisites for your data sur laquelle on trouve aussi un message qui précise que les données listées sont celles des données initiales.

[camillemonchicourt]

OK, mais en fait je crois que je comprends pas ce titre de rubrique.
"Importer des données / Pré-requis pour vos données".
En fait le titre devrait uniquement être "Minimal initial data" plutôt, non ?

[bruhnild]

Oui, je reconnais que le titre pouvait porter à confusion, je l'ai changé : https://geotrek.readthedocs.io/en/mfu-improve-doc-gta/install/minimal-initial-data.html

[bruhnild]

Sur certaines pages il y a des titres de section qui sont "bizarres"

C'est déjà le cas aujourd'hui mais ça pourrait être corrigé au passage

Oui, il s'agit de la syntaxe .. envvar:: qui est mal interprétée dans le thème de la doc. Il y en avait énormément dans la page advanced configuration.
Je les ai tous remplacé par des titres de 4 ème ou 3èeme niveau.

[bruhnild]

Bon sinon, j'en peux plus de cette page infernale : https://geotrek.readthedocs.io/en/mfu-improve-doc-gta/install/advanced-configuration.html
Est ce qu'on en ferait pas une section à part, au même titre qu'on en a fait une pour Import data ?

Oui on pourrait faire ça. Ca ferait donc trois grosses sections :

* Installation (+ maintenance, upgrade, etc)

* Configuration

* Import data

Si on sépare cette grosse page de settings en plusieurs il faudrait trouver une organisation "logique" quand même. Car aujourd'hui l'avantage d'une seule page c'est que quand on cherche un paramètre on sait qu'on va le retrouver dedans. Si c'est sur plusieurs pages ça implique de chercher un peu plus donc il faut que ce soit clair ce qui est sur chaque page.

(bon ceci dit la fonction de recherche de la doc marche très bien)

J'ai un peu pris les devants depuis mon commentaire et splité la page en autant de sous-pages qu'il y avait de sous-titres pour garder la structure. L'organisation reste la même mais on y voit plus clair pour réorganiser en profondeur : https://geotrek.readthedocs.io/en/mfu-improve-doc-gta/advanced-configuration/application-settings.html

[babastienne]

Est-ce bien utile de conserver en haut de chaque page un bloc "table of content" (1) alors qu'il y en a déjà une à droite de la page (2) ?

Pour alléger j'aurai tendance à retirer ça sur l'ensemble des pages.

[bruhnild]

Est-ce bien utile de conserver en haut de chaque page un bloc "table of content" (1) alors qu'il y en a déjà une à droite de la page (2) ?

Pour alléger j'aurai tendance à retirer ça sur l'ensemble des pages.

Effectivement, c'était redondant et alourdissait les pages. J'ai retiré les TOC sur toutes les pages de la doc (le menu de droite s'en charge)