Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refonte : pages auteurs et section équipe #915

Merged
merged 20 commits into from
May 4, 2024

Conversation

Guts
Copy link
Member

@Guts Guts commented May 1, 2023

Objectifs

Résoudre quelques problèmes et répondre à certains besoins liés aux pages/blocs auteur/ice :

  • l'intégration actuelle intègre un bloc de niveau 1, ce qui rend la page finale non conforme avec le HTML (une seule balise h1 par page)
  • la syntaxe d'intégration actuelle est assez lourde avec des balises jinja qui sont peu compréhensibles
  • la page d'une auteur/ice n'est pas visible de façon indépendante
  • on ne visibilise pas assez les auteur/ices
  • il manque une page listant tous les auteur/ices
  • ce serait cool d'avoir la liste des contenus créés par chaque auteur/ice sur sa page

Changements effectués

Le code d'intégration du bloc auteur

Désormais l'intégration tient en un commentaire :

<!-- geotribu:authors-block -->

Note

Il faut que ce commentaire soit présent dans la page. Je ferai une évolution pour vérifier et l'ajouter à la volée.

Un hook vient automatiquement intégrer le bloc auteur en gérant :

  • les auteurs mutiples
  • l'auteur générique Geotribu
  • le bon niveau de titre dans la structure HTML
  • l'intégration à la navigation de droite
  • le nom est un lien vers la page complète

Avant

image

Après

image

La page auteur/ice

Une page auteur/ice est désormais une page à part entière avec les mêmes options que les autres dans l'en-tête (image, icon, description, sous-titre, etc.) plus des options spécifiques pour les comptes sur les réseaux sociaux :

social:
    - github: guts
    - gitlab: geojulien
    - linkedin: julienmoura
    - mail: julien@ingeoveritas.com
    - mastodon:
        - instance: mapstodon.space
        - username: geojulien
    - twitter: geojulien

Pour l'instant ces informations ne sont pas utilisées mais le seront dans #1086 entre autres.

Balises de définition du bloc de signature

L'un des éléments bloquants jusqu'à présent était que l'intégration du bloc auteur était la page entière, ce qui empêchait d'y mettre plus que quelques lignes.
Désormais il faut indiquer où commence et où finit la partie de la page qui est destinée à être intégrée comme signature.

Exemple :

# Julien Moura

<!-- --8<-- [start:author-sign-block] -->
![Portrait Julien Moura](https://cdn.geotribu.fr/img/internal/contributeurs/jmou.jfif "Portrait Julien Moura"){: .img-thumbnail-left }

Géographe "sigiste" de formation, j'ai travaillé sur différentes thématiques et types de structures : gestion des déchets en milieu urbain à Madagascar, foncier d'intérêt général auprès de [l'EPF de La Réunion](http://www.epf-reunion.com/), organisation et la résilience urbaine face aux risques naturels à Lima pour l'IRD, gouvernance et ouverture des données à [Isogeo](https://www.isogeo.com).

Je travaille désormais à [Oslandia](https://oslandia.com/).  
Féru des dynamiques de contributions, je participe activement à Geotribu depuis fin 2011.

<!-- --8<-- [end:author-sign-block] -->

Limitations

Caution

Aucun niveau de titre > 3 ne doit faire partie du bloc de signature.

Section "À propos" scindée

  • extraction des pages auteur/ices dans une section Auteur-ices
  • ajout d'un emoji pour le lien vers le site de contribution

Avant :

image

Après :

image


À suivre

Dans de prochaines PRs :

  • vérifier la présence de la balise d'intégration du bloc de signature
  • intégrer automatiquement la liste des articles d'un/e auteur/ice sur sa page
  • intégrer automatiquement les comptes des réseaux sociaux sur la page auteur/ice - et dans le bloc signature ?
  • CLI geotribu : utiliser les comptes des réseaux sociaux pour générer les messages des réseaux sociaux de partage (parce-que c'est laborieux de trouver les bons comptes à coup de @)

@github-actions github-actions bot added articles Tutoriels, actualité, billet... contributeurices Contenus liés à la contribution et contributeur/ices : biographies, à propos, etc. labels May 1, 2023
@github-actions

This comment has been minimized.

2 similar comments
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@Guts Guts marked this pull request as ready for review April 26, 2024 18:17
@Guts Guts force-pushed the feature/improve-authors-integration branch from f2e0558 to 2a8c9e2 Compare April 26, 2024 18:18
@github-actions github-actions bot added the enhancement Ajout ou amélioration d'une fonctionnalité label Apr 26, 2024

This comment has been minimized.

@github-actions github-actions bot added the outillage Linter, git hooks, CI, CD, build, compilation, devops, intégration et déploiement continus, etc. label Apr 27, 2024

This comment has been minimized.

@github-actions github-actions bot added the thème Personnalisation du thème du site (CSS, JS, partials...) label Apr 28, 2024

This comment has been minimized.

@Guts Guts mentioned this pull request Apr 29, 2024
9 tasks
@github-actions github-actions bot added rdp Revues de presse mkdocs Tout ce qui est lié au générateur de site : configuration, hooks, scripts... labels May 2, 2024
@Guts Guts self-assigned this May 2, 2024

This comment has been minimized.

2 similar comments

This comment has been minimized.

This comment has been minimized.

@github-actions github-actions bot added the contenus communs Contenus génériques et communs au site : page d'accueil, glossaire, snippets, licences... label May 2, 2024

This comment has been minimized.

@Guts Guts force-pushed the feature/improve-authors-integration branch from 612abaa to 46e2de8 Compare May 3, 2024 07:02

This comment has been minimized.

1 similar comment

This comment has been minimized.

@Guts Guts force-pushed the feature/improve-authors-integration branch from 46e2de8 to 243898b Compare May 3, 2024 07:39

This comment has been minimized.

@Guts Guts changed the title Amélioration des pages auteurs Refonte : pages auteurs et section équipe May 3, 2024

This comment has been minimized.

Copy link
Contributor

@gounux gounux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

C'est cool ça @Guts

hooks/mkdocs/G006_authors_block.py Show resolved Hide resolved
content/team/index.md Outdated Show resolved Hide resolved
content/team/index.md Outdated Show resolved Hide resolved
Guts and others added 2 commits May 3, 2024 12:49
Co-authored-by: Guilhem Allaman <40383801+gounux@users.noreply.github.com>
Signed-off-by: Julien <dev@ingeoveritas.com>
Co-authored-by: Guilhem Allaman <40383801+gounux@users.noreply.github.com>
Signed-off-by: Julien <dev@ingeoveritas.com>

This comment has been minimized.

1 similar comment

This comment has been minimized.

Co-authored-by: Guilhem Allaman <40383801+gounux@users.noreply.github.com>
Signed-off-by: Julien <dev@ingeoveritas.com>

This comment has been minimized.

Co-authored-by: Guilhem Allaman <40383801+gounux@users.noreply.github.com>
Signed-off-by: Julien <dev@ingeoveritas.com>
Copy link
Contributor

github-actions bot commented May 4, 2024

👏 Le markdown ajouté ou modifié est impeccable ! Merci 🥇

Copy link
Contributor

github-actions bot commented May 4, 2024

🎉 Le site de prévisualisation pour cette PR a été généré et est disponible sous ce lien.
Commit de référence : 92a3fb4.

@Guts Guts merged commit 2c89014 into master May 4, 2024
6 checks passed
@Guts Guts deleted the feature/improve-authors-integration branch May 4, 2024 08:53
@github-actions github-actions bot temporarily deployed to pr-previews May 4, 2024 08:53 Inactive
Guts added a commit that referenced this pull request May 6, 2024
Guts added a commit that referenced this pull request May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
articles Tutoriels, actualité, billet... contenus communs Contenus génériques et communs au site : page d'accueil, glossaire, snippets, licences... contributeurices Contenus liés à la contribution et contributeur/ices : biographies, à propos, etc. enhancement Ajout ou amélioration d'une fonctionnalité mkdocs Tout ce qui est lié au générateur de site : configuration, hooks, scripts... outillage Linter, git hooks, CI, CD, build, compilation, devops, intégration et déploiement continus, etc. rdp Revues de presse thème Personnalisation du thème du site (CSS, JS, partials...)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants