Opportunités de contribution à la documentation

[hugh (Hugh Lashbrooke)]

La documentation Discourse est le principal lieu où les administrateurs, modérateurs, utilisateurs et administrateurs système peuvent trouver de l’aide pour utiliser Discourse et gérer leurs sites.

Bien que cette documentation soit complète et couvre de nombreux aspects, il existe des domaines manquants que nous n’avons pas encore documentés. C’est une excellente opportunité pour la communauté de s’impliquer dans le perfectionnement de cette partie importante du projet Discourse.

Nous aimerions voir plus de personnes s’impliquer dans la création de contenu de documentation pour Discourse, et nous voulons rendre cela aussi facile que possible pour tout le monde. À cette fin, ci-dessous une liste de fonctionnalités ou de cas d’utilisation de Discourse qui, selon nous, nécessitent une documentation nouvelle ou améliorée.

Emplacements de la documentation

Toute personne ayant un niveau de confiance 2 ou supérieur peut créer de nouveaux sujets de documentation dans Community wiki - c’est le foyer de tout le contenu de documentation contribué par la communauté. Si un sujet dans le wiki communautaire est considéré comme pertinent ou important, il peut être déplacé vers Documentation - le foyer de toute la documentation officielle de Discourse. Vous pouvez lire la politique de documentation pour plus de détails à ce sujet.

Badges pour les contributeurs de documentation

Toute personne qui crée un nouveau sujet dans la catégorie Community wiki recevra automatiquement le badge Scribe de bronze :

Si le sujet est jugé suffisamment précieux pour être déplacé dans la catégorie officielle Documentation, une personne de l’équipe Discourse le fera manuellement, créditera l’auteur original dans le contenu du sujet et lui attribuera le badge Ghostwriter d’argent :

Documentation à rédiger

Bien que nous souhaitions à terme que chaque partie de Discourse soit entièrement documentée, voici les domaines que nous avons identifiés comme étant les plus urgents (les éléments barrés indiquent les sujets qui ont été rédigés depuis la publication initiale de ce message) :

• Un tutoriel général de démarrage pour les administrateurs
• Redirections de sujets personnalisées
• Explication de ce que peuvent faire les différents niveaux d’utilisateurs
• Options de connexion sociale
• Avis de publication (doc officielle)
• Plus de documentation sur le fonctionnement des niveaux de confiance
• Comment rédiger une bonne demande de fonctionnalité pour Discourse (sujet wiki)
• Une référence sur l’apparence du markdown et des fonctionnalités de formatage de Discourse lorsqu’ils sont inclus dans les e-mails
• Statuts des utilisateurs (sujet wiki)
• Explication du mode sombre, comment le sélectionner et comment activer le changement (sujet wiki)
• Documentation générale couvrant la gestion des préférences utilisateur (sujet wiki)
• Docs expliquant le fonctionnement des catégories et de la hiérarchie dans Discourse
• Un guide général pour les paramètres de sujet
• Un guide général sur les plugins - ce qu’ils sont, comment ils fonctionnent et comment les utiliser
• Pages d’accueil personnalisées
• Modification des catégories et des sujets par défaut
• Utilisation de grilles d’images dans les publications (sujet wiki)
• Paramètres d’approbation des publications (sujet wiki)

Certains de ces éléments peuvent nécessiter plusieurs sujets pour être documentés efficacement.

Comment rédiger de la documentation

Afin de garantir que la documentation Discourse soit aussi efficace que possible, nous avons un guide de style sur la façon de rédiger ce contenu. Bien qu’il soit utile que tout le monde suive le guide, si vous contribuez à Community wiki, ce n’est pas un problème si vous ne vous y tenez pas complètement. Tous les sujets qui seront déplacés vers Documentation seront mis à jour par le personnel de Discourse pour correspondre au guide de style si nécessaire.

Intéressé ?

Plongez dans Community wiki et commencez à documenter dès aujourd’hui. Si vous souhaitez discuter de tout cela, n’hésitez pas à répondre à ce sujet pour en parler.

[Moin]

Qu’en est-il des sujets existants ? Par exemple

@hugh

Comment accorder des privilèges d’administrateur ou de modérateur aux utilisateurs

Promoting a User to Admin or Moderator Status

This is a how-to guide intended to help existing site admins understand how to promote a user to admin or moderator status through Discourse. Required user level: Administrator Admin privileges in Discourse are powerful and allow the user to manage almost all aspects of the site. For full details on what staff users can do on a site, see Understanding user statuses, roles, and permissions. Here is a step-by-step process on how to promote a user to admin or …

@hugh

Comment rédiger une bonne demande de fonctionnalité pour Discourse

Requesting new features for Discourse

This guide explains how to request new features for Discourse, check existing plans, and increase the chances of your feature request being prioritized. Required user level: Anyone can submit a feature request Got a great idea for a Discourse feature? That’s fantastic! Here’s how you can share it with the team effectively. Make sure your feature isn’t already made or planned Before submitting a new feature request, ensure it’s not already available or plann…

[hugh (Hugh Lashbrooke)]

Pour celui-ci :

@Moin

@hugh

Comment rédiger une bonne demande de fonctionnalité pour Discourse

Demander de nouvelles fonctionnalités pour Discourse

La documentation existante explique comment demander de nouvelles fonctionnalités, mais pas comment formater une bonne demande pour la rendre plus efficace. Nous renvoyons actuellement vers cette page, mais ce serait bien si nous pouvions avoir ce type de contenu sur Meta à la place.

Et pour celui-ci :

@Moin

@hugh

Comment accorder des privilèges d’administrateur ou de modérateur aux utilisateurs

Accorder des privilèges d’administrateur ou de modérateur à un utilisateur

Bonne remarque ! Je vais supprimer cela de la liste dans ce sujet

[ondrej]

@hugh

Comment écrire une bonne demande de fonctionnalité pour Discourse

Il y a déjà ce sujet qui couvre les demandes de fonctionnalités

Requesting new features for Discourse

This guide explains how to request new features for Discourse, check existing plans, and increase the chances of your feature request being prioritized. Required user level: Anyone can submit a feature request Got a great idea for a Discourse feature? That’s fantastic! Here’s how you can share it with the team effectively. Make sure your feature isn’t already made or planned Before submitting a new feature request, ensure it’s not already available or plann…

À moins qu’il ne doive ressembler à ceci mais pour une demande de fonctionnalité ?

Writing an effective bug report

This is a guide for writing effective bug reports in Discourse to maximize the chances of getting bugs fixed. Required user level: Any can report a bug Writing a good bug report is essential to help the Discourse team fix issues efficiently. This guide will walk you through the steps and best practices to ensure your bug report is clear, concise, and actionable. Summary In this documentation, we’ll cover: The importance of providing reproducible steps and…

[HamMan2118]

@hugh

Avis de publication

Est-ce que cela signifie un avis du personnel ou quelque chose de différent ?

[ondrej]

Je suppose qu’il s’agit d’un avis de publication car il figure dans le titre

Post notices for first-time and returning users

To encourage kindness towards users who are posting for the first time or may not have posted in a while we’ve created a new feature that calls special attention to these new/returning users. These banners are visible to other users, but not the poster they apply to… and by default are only visible to community members who have been active enough to achieve Trust Level 2. Here’s what they look like: [image] [image] How can I configure this feature? Admins can adjust these options in their…

Les avis du personnel sont à peu près les mêmes, je suppose ?

[hugh (Hugh Lashbrooke)]

@ondrej

Sauf si cela doit ressembler à ceci mais pour une demande de fonctionnalité ?

Oui, c’est ce que nous recherchons là

@HamMan2118

@hugh

Avis de publication

Cela signifie-t-il un avis du personnel ou quelque chose de différent ?

Comme @ondrej l’a lié, les avis de publication sont ceux décrits dans cette annonce. Nous avons ce sujet d’annonce, mais pas de documentation réelle à ce sujet.

[Heliosurge (Dan DeMontmorency)]

Salut Hugh, c’est une excellente idée.

J’avais l’intention de proposer une idée pour le wiki communautaire afin d’avoir une sorte d’étiquette pour, disons, les modèles de forum.

L’idée que j’ai pour cela. Souvent, des gens demandent comment utiliser Discourse pour des choses comme un forum de support, une plateforme d’apprentissage, etc. Même parfois des utilisations plus obscures comme un JdR sur table.

En collectant du contenu à partir de sujets comme ceux-là et même en réfléchissant à diverses utilisations. Nous pourrions créer une nouvelle ressource avec un sujet principal servant d’index.

• Modèles de forum de support
• Modèles de plateforme d’apprentissage

Ces sujets peuvent héberger Discourse, Communique (?), etc., avec des plugins et des composants de thème recommandés, etc. Ainsi qu’un message pour l’auto-hébergement.

Les modèles hébergés se concentreraient sur les plugins et indiqueraient quels plans sont nécessaires pour un plugin particulier à utiliser.

Avec des astuces et des conseils, et même en orientant les gens vers le Marketplace s’ils ont besoin d’une mise en page personnalisée, d’un plugin, etc.

[NateDhaliwal]

@hugh

Statuts personnalisés des utilisateurs

Créé :

Custom User Statuses

Summary This document covers: What a Custom User Status Is How to add, modify, and remove a custom user status. Custom User Status Description A Custom User Status is a feature where users can set a custom status and icon to appear in their profile and next to their avatar at posts. This can be used, as a member, to let the community know if you are unavailable, on vacation, or want to share how you are feeling. A custom user status appears like this in a post: [Username "andrei" with a pal…

[hugh (Hugh Lashbrooke)]

Je l’ai vu Ravi de voir que ça arrive !

[NateDhaliwal]

Je travaille sur celui du mode sombre.

[NateDhaliwal]

Ces guides ont déjà été créés mais pas encore cochés :

@hugh

Statuts des utilisateurs

Custom User Statuses

Summary This document covers: What a Custom User Status Is How to add, modify, and remove a custom user status. Custom User Status Description A Custom User Status is a feature where users can set a custom status and icon to appear in their profile and next to their avatar at posts. This can be used, as a member, to let the community know if you are unavailable, on vacation, or want to share how you are feeling. A custom user status appears like this in a post: [Username "andrei" with a pal…

@hugh

Utilisation de grilles d’images dans les messages

Image Grids

This guide explains what Image Grids are and how to apply them in your posts. Required user level: Trust Level 0 Summary This document covers: Description of image grids How they can be applied in posts and how to modify them Basic Layout of image grids Image Grids Description An image grid places all of the images in your post into a neat, organized grid - rather than in a list. Below is an example of an image grid. [Delta A321-200 Landing in Washingt…

@hugh

Pages d’accueil personnalisées

Celui-ci est un peu flou. Fait-il référence au contenu personnalisé de la page d’accueil ? Si oui, alors peut-être Add custom content that only appears on your homepage. Sinon… il n’a pas encore été écrit.

[hugh (Hugh Lashbrooke)]

Merci d’être revenu sur ce sujet - J’ai mis à jour le message initial avec ces liens.

@NateDhaliwal

Celle-ci est un peu floue. Fait-elle référence au contenu personnalisé de la page d’accueil ?

C’est une chose assez spécifique et fait référence à la création d’une page d’accueil personnalisée, donc ce n’est pas vraiment quelque chose que la plupart des administrateurs Discourse utiliseront. Ce n’est pas une fonctionnalité principale, car elle n’est pas entièrement finalisée à ce stade.