Improve doc with new sections #3890

bruhnild · 2024-01-17T14:39:38Z

Description

Related Issue

Checklist

docs/usage/editing-objects.rst

docs/usage/externals-apis.rst

docs/usage/overview.rst

docs/usage/touristic-modules.rst

cypress · 2024-01-19T16:30:02Z

Passing run #8115 ↗︎

0	24	0	0	0

Details:

Merge `b0bfb06` into `ad649e5`...
Project: Geotrek-admin	Commit: `4eb41b3eb6 ℹ️`
Status: Passed	Duration: 02:10 💡
Started: Feb 28, 2024 6:31 PM	Ended: Feb 28, 2024 6:33 PM

Review all test suite changes for PR #3890 ↗︎

codecov · 2024-01-19T16:35:47Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.35%. Comparing base (ad649e5) to head (b0bfb06).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #3890   +/-   ##
=======================================
  Coverage   98.35%   98.35%           
=======================================
  Files         294      294           
  Lines       22292    22292           
=======================================
  Hits        21925    21925           
  Misses        367      367

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

bruhnild · 2024-01-19T16:51:42Z

You can visualize changes here : https://geotrek.readthedocs.io/en/mfu-improve-doc/about/geotrek.html

babastienne · 2024-01-19T16:53:00Z

Est-ce possible de fusionner un peu les commits ? 42 commits pour une PR de doc ça me parait assez élevé.

bruhnild · 2024-01-19T16:58:31Z

Est-ce possible de fusionner un peu les commits ? 42 commits pour une PR de doc ça me parait assez élevé.

Je pourrais les fusionner au moment du merge de la PR

babastienne · 2024-01-23T20:26:44Z

Review rapide :

Page d'accueil
- Section "Les 4 briques" : possible de rajouter un lien sur chaque brique vers la documentation dédiée ?
Section "Présentation générale" : ça j'adore 😍 C'est très chouette. Peut-être à faire relire par @camillemonchicourt ?
Section "Modules de valorisation" :
- il manque pas mal d'infos sur certains modules.
- Pour es sections "Outdoor" il y a une erreur, il y est évoqué le module Zones sensibles qui n'a rien à voir
- Pourquoi ne pas y mettre directement toute la section "Activités Outdoor" dedans ?
- Section "Activité outdoor" : les images HD ne sont pas relatives qu'aux activités outdoor, c'est aussi possible sur les itinéraires. Peut-être en faire une section dédiée plutôt que de l'inclure dans l'outdoor ?
A suivre ...

camillemonchicourt

Merci pour ces ajouts très utiles.
J'ai fait une relecture complète et de nombreuses suggestions d'ajustements, ainsi que quelques commentaires.

docs/about/geotrek.rst

docs/usage/touristic-modules.rst

camillemonchicourt

Je remets 4 suggestions qui avaient été validées mais ont ensuite sauté avec l'ajout d'URL il me semble.
Merci.

docs/about/geotrek.rst

babastienne · 2024-01-30T20:45:21Z

@bruhnild gros boulot cette doc. Quitte à mettre les mains dans le truc autant aller jusqu'au bout. J'ai commencé à faire une review et finalement j'ai directement modifié les éléments en local sur mon poste. J'ai donc continué un peu, en reprenant certaines parties, en mettant à jour la configuration de la doc, changeant certains éléments, etc.

J'ai aussi enlevé la numérotation car ça me semblait être une mauvaise idée, je t'expliquerai pourquoi.

Il faut encore que je relise pas mal de fichiers, donc travail toujours en cours, pas fini de mon côté.

J'aimerai aussi qu'on puisse se pencher sur weblate pour être sur que c'est à jour, et j'aimerai qu'on réfléchisse à la traduction de la doc.

J'ai ajouté quelques commits. Ca serait bien de ne pas tout fusionner au moment de merger car il faudra garder une trace avec une granularité plus fine que "toute la PR" vu que j'ai touché à pas mal de choses et qu'on est maintenant deux travailler sur cette PR. Il faudrait donc faire le tri dans tes commits et fusionner ceux qui peuvent l'être, j'ai déjà commencé mais il y en a surement d'autres à faire.

A suivre ...

… interface

…h TOC

babastienne

Est-ce possible de vérifier que toutes les images présentes dans /docs/images sont bien utilisées quelque part dans le doc ? S'il y a des images non utilisées il faudrait les retirer.

docs/about/geotrek.rst

docs/contribute/contributing.rst

docs/usage/touristic-modules.rst

babastienne · 2024-02-28T13:58:05Z

docs/usage/touristic-modules.rst

+
+Ces derniers servent à y faire référence dans le champs Description de l'itinéraire (Pas à pas) :
+
+.. image :: /images/user-manual/references-geotrek-rando.jpg


Ca serait chouette de mettre une capture d'écran plus moderne, là c'est un Geotrek-Rando V2,c 'est un peu vieillot.

babastienne · 2024-02-28T14:05:33Z

docs/usage/touristic-modules.rst

+
+.. image :: /images/user-manual/references-geotrek-admin.jpg
+
+Ordre des catégories


Pourquoi l'avoir mis comme un sous-titre de la section "Points de référence" ? Pour moi c'est une sous-section d'une catégorie du style "Interface générale" puisqu'il s'agit de l'interface de GTR3. D'ailleurs je pense que ça aurait même plutôt sa place dans la doc de GTR3 plutôt qu'ici.

babastienne · 2024-02-28T14:05:37Z

docs/usage/touristic-modules.rst

+
+Pour définir leur ordre d'affichage, il est possible de le définir dans la base de données pour certains contenus (ordre des pratiques des itinéraires et des catégories de contenus touristiques) en renseignant leur champs ``ordre`` depuis le module de configuration de Geotrek-admin.
+
+Zone tampon pour contenus à proximité


Pourquoi l'avoir mis comme un sous-titre de la section "Points de référence" ? Pour moi c'est une sous-section de la section "Contenus Touristiques". A re-ordonner.

babastienne · 2024-02-28T14:05:44Z

docs/usage/touristic-modules.rst

+Pour importer automatiquement des éléments de POIs, se référer à la section :ref:`Import POIs <import-pois>`
+
+.. _services:
+


Rajouter une "note" (encart bleu) : Lorsque Geotrek est installé en mode "sans segmentation dynamique", les POI sont rattachés aux itinéraires par zone tampon (buffer). Dans ce cas le paramètre pris en compte est le paramètre TREK_POI_INTERSECTION_MARGIN qui est paramétrable dans le custom.py.

Il faut voir si ce n'est pas l'occasion d'ajouter dans advanced configuration aussi une section sur ce paramètre qui pour le moment n'est pas documenté. Et si c'est le cas il faudra que la note rajoutée plus aut redirige vers cette section.

docs/usage/apis.rst

docs/usage/configuration-ttw.rst

docs/about/geotrek.rst

babastienne · 2024-02-28T16:17:34Z

docs/about/geotrek.rst

+* Aider les utilisateurs et répondre aux questions sur la `mailing-list <https://groups.google.com/g/geotrek-fr>`_ 
+* `Ouvrir un ticket <https://github.com/GeotrekCE/Geotrek-admin/issues/new>`_ lorsqu'un bug est détecté
+* `Ouvrir un ticket <https://github.com/GeotrekCE/Geotrek-admin/issues/new>`_ pour proposer une suggestion ou une nouvelle fonctinonalité
+* Traduire la documentation
+* Traduire les menus, boutons et , labels (nous utilisons `Weblate <https://weblate.makina-corpus.net>`_) 
+* Maintenir le script d'installation pour les différentes distributions Linux (*nécessite quelques compétences de base Linux*)
+* Corriger des bugs ou améliorer la mise en page et l'apparence (*nécessite des compétences de webmaster*)
+* Corrigez des bugs ou améliorez les modules de base (*nécessite des compétences python/Django*)


Pour le coup toute cette partie j'aurai conservé dans "Contributing", car c'est une manière de contribuer au projet.

Dans cette section "Comment rejoindre la communauté", je verrai :

La ligne que tu as insérée ci-dessous

Eventuellement les lignes "ouvrir un ticket" bug + feature

Une ligne sur le canal de discussion Matrix, avec un lien vers le canal. Inspire toi de ce mail

Co-authored-by: babastienne <[email protected]>

bruhnild requested review from babastienne and removed request for babastienne January 17, 2024 14:40

bruhnild marked this pull request as draft January 17, 2024 15:36

bruhnild changed the title ~~update doc~~ [Doc] Improve doc Jan 17, 2024

camillemonchicourt requested changes Jan 18, 2024

View reviewed changes

bruhnild changed the title ~~[Doc] Improve doc~~ [📝 Documentation] Improve doc with new sections Jan 18, 2024

bruhnild force-pushed the mfu-improve-doc branch from 298eb91 to 9904217 Compare January 19, 2024 16:18

bruhnild requested review from camillemonchicourt and babastienne January 19, 2024 16:41

bruhnild marked this pull request as ready for review January 19, 2024 16:42

camillemonchicourt reviewed Jan 23, 2024

View reviewed changes

camillemonchicourt reviewed Jan 24, 2024

View reviewed changes

docs/about/geotrek.rst Outdated Show resolved Hide resolved

docs/about/geotrek.rst Outdated Show resolved Hide resolved

docs/about/geotrek.rst Outdated Show resolved Hide resolved

docs/about/geotrek.rst Outdated Show resolved Hide resolved

camillemonchicourt approved these changes Jan 24, 2024

View reviewed changes

babastienne force-pushed the mfu-improve-doc branch from c4103c8 to e5742e8 Compare January 30, 2024 20:40

bruhnild force-pushed the mfu-improve-doc branch from ba5d223 to 5d6314d Compare February 5, 2024 10:05

babastienne force-pushed the mfu-improve-doc branch from 5d6314d to 7694e06 Compare February 13, 2024 19:33

babastienne mentioned this pull request Feb 13, 2024

Change theme for documentation #3937

Closed

11 tasks

babastienne marked this pull request as draft February 13, 2024 19:40

bruhnild mentioned this pull request Feb 15, 2024

[Documentation] Starting documentation GeotrekCE/Geotrek-rando-widget#80

Merged

bruhnild added 4 commits February 28, 2024 10:57

📝 [Documentation] Re-organize sections, add TOC, improve contents

264d5ab

📝 [Documentation] Add sentitive area description

29fa8d4

📝 [Documentation] Add informations about loading shapefiles with user…

ec4a1ef

… interface

📝 [Documentation] Update doc from reviews

be2b3d8

Bastien Potiron and others added 12 commits February 28, 2024 10:57

💄 [Update] Favicon for GTA website

c6041cf

💄 [Update] Favicon, logo and configuration for documentation

4db88e8

♻ [Refactoring] Change organization of files in documentation to matc…

82636d3

…h TOC

🔥 [Purify] Remove unused comments in configuration file of documentation

c88449a

🔥 [Simplify] Remove nunmbers for sections in documentation

001387d

📝 [Improve] Minor improvements on documentation content

9f5aa01

[Remove] Unused SVG file

b7619b8

📝 [Documentation] Improve documentation and add pictures

6983b68

📝 [Documentation] Remove all mention to Adminsite

f0b7813

📝 [Documentation] Update permissions doc

9121337

📝 [Documentation] Improve advanced configuration parameters

90933b2

📝 [Documentation] Renomage Admin site to Configuration module

22917c4

babastienne force-pushed the mfu-improve-doc branch from 44511e3 to 22917c4 Compare February 28, 2024 10:01

babastienne requested changes Feb 28, 2024

View reviewed changes

docs/about/geotrek.rst Outdated Show resolved Hide resolved

docs/about/geotrek.rst Outdated Show resolved Hide resolved

docs/contribute/contributing.rst Show resolved Hide resolved

bruhnild force-pushed the mfu-improve-doc branch from 4f6c107 to e1143aa Compare February 28, 2024 13:58

babastienne reviewed Feb 28, 2024

View reviewed changes

📝 [Documentation] Update user manual sections

b0bfb06

Co-authored-by: babastienne <[email protected]>

bruhnild force-pushed the mfu-improve-doc branch from c0910a8 to b0bfb06 Compare February 28, 2024 18:19

bruhnild added the 📝 Documentation label Feb 28, 2024

bruhnild marked this pull request as ready for review February 28, 2024 18:22

babastienne approved these changes Feb 28, 2024

View reviewed changes

babastienne merged commit 531a27a into master Feb 28, 2024
13 of 15 checks passed

babastienne deleted the mfu-improve-doc branch February 28, 2024 22:11

submarcos restored the mfu-improve-doc branch February 29, 2024 09:06

submarcos mentioned this pull request Feb 29, 2024

Revert " [📝 Documentation] Improve doc with new sections" #3963

Merged

babastienne changed the title ~~[📝 Documentation] Improve doc with new sections~~ Improve doc with new sections Feb 29, 2024

submarcos deleted the mfu-improve-doc branch March 1, 2024 13:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve doc with new sections #3890

Improve doc with new sections #3890

bruhnild commented Jan 17, 2024

cypress bot commented Jan 19, 2024 •

edited

Loading

codecov bot commented Jan 19, 2024 •

edited

Loading

bruhnild commented Jan 19, 2024 •

edited

Loading

babastienne commented Jan 19, 2024

bruhnild commented Jan 19, 2024

babastienne commented Jan 23, 2024

camillemonchicourt left a comment

camillemonchicourt left a comment

babastienne commented Jan 30, 2024

babastienne left a comment

babastienne Feb 28, 2024

babastienne Feb 28, 2024

babastienne Feb 28, 2024

babastienne Feb 28, 2024

babastienne Feb 28, 2024


		Ces derniers servent à y faire référence dans le champs Description de l'itinéraire (Pas à pas) :

		.. image :: /images/user-manual/references-geotrek-rando.jpg


		.. image :: /images/user-manual/references-geotrek-admin.jpg

		Ordre des catégories


		Pour définir leur ordre d'affichage, il est possible de le définir dans la base de données pour certains contenus (ordre des pratiques des itinéraires et des catégories de contenus touristiques) en renseignant leur champs ``ordre`` depuis le module de configuration de Geotrek-admin.

		Zone tampon pour contenus à proximité

		Pour importer automatiquement des éléments de POIs, se référer à la section :ref:`Import POIs <import-pois>`

		.. _services:

Improve doc with new sections #3890

Improve doc with new sections #3890

Conversation

bruhnild commented Jan 17, 2024

Description

Related Issue

Checklist

cypress bot commented Jan 19, 2024 • edited Loading

Passing run #8115 ↗︎

Review all test suite changes for PR #3890 ↗︎

codecov bot commented Jan 19, 2024 • edited Loading

Codecov Report

bruhnild commented Jan 19, 2024 • edited Loading

babastienne commented Jan 19, 2024

bruhnild commented Jan 19, 2024

babastienne commented Jan 23, 2024

camillemonchicourt left a comment

Choose a reason for hiding this comment

camillemonchicourt left a comment

Choose a reason for hiding this comment

babastienne commented Jan 30, 2024

babastienne left a comment

Choose a reason for hiding this comment

babastienne Feb 28, 2024

Choose a reason for hiding this comment

babastienne Feb 28, 2024

Choose a reason for hiding this comment

babastienne Feb 28, 2024

Choose a reason for hiding this comment

babastienne Feb 28, 2024

Choose a reason for hiding this comment

babastienne Feb 28, 2024

Choose a reason for hiding this comment

cypress bot commented Jan 19, 2024 •

edited

Loading

codecov bot commented Jan 19, 2024 •

edited

Loading

bruhnild commented Jan 19, 2024 •

edited

Loading