Ce plugin est en cours de retrait au profit du plugin expérimental Catégories de documents. Nous continuerons à prendre en charge Docs jusqu’à ce que le nouveau plugin ne soit plus considéré comme expérimental.
 |
Résumé | Discourse Docs permet de trouver et de filtrer des sujets de base de connaissances |
 |
Lien vers le dépôt | https://github.com/discourse/discourse-docs |
 |
Guide d’installation | Comment installer des plugins dans Discourse |
Fonctionnalités
Le plugin Discourse Docs est un outil puissant qui transforme votre forum Discourse en une base de connaissances alimentée par la communauté. Il fournit une section dédiée aux Documents où les utilisateurs peuvent créer, mettre à jour et organiser la documentation. Ce plugin dispose d’un bouton Docs qui permet un accès facile à cette section. C’est un excellent moyen de tirer parti des connaissances collectives de votre communauté et de fournir une ressource centralisée pour les informations importantes.
En essence, Docs permet de mettre plus facilement en évidence des sujets de type base de connaissances dans un ensemble défini de catégories et/ou d’étiquettes.
Filtrez la liste par étiquettes, recherchez via la barre de recherche et cliquez sur les sujets pour voir le premier message, le tout sans quitter le contexte de l’explorateur de connaissances.
Vous devez trouver un sujet de base de connaissances depuis ailleurs dans Discourse ? Utilisez le nouvel assistant de recherche : in:kb.
Configuration
-
Activez le plugin en activant le paramètre
docs enabled. -
Ajoutez des catégories et des étiquettes aux paramètres
docs categoriesetdocs tags. -
Trouvez le lien Docs dans le menu de navigation.
- Profitez d’un accès plus facile aux connaissances !
Paramètres
| Nom | Description |
|---|---|
| docs enabled | Activer le plugin Docs |
| docs categories | Une liste de slugs de catégories à inclure dans les documents |
| show tags by group | Organiser les étiquettes en utilisant des groupes d’étiquettes. Créez des groupes pour catégoriser les étiquettes associées. |
| docs tag groups | Les groupes d’étiquettes utilisés pour afficher les étiquettes par groupe |
| docs tags | Une liste d’étiquettes à inclure dans les documents |
| docs add solved filter | Ajoute un filtre pour les sujets résolus – nécessite que Discourse Solved soit installé et activé |
| docs add to top menu | Ajoute un lien au menu supérieur pour naviguer vers la vue Docs |
| docs add search menu tip | Ajoute l’astuce « in:docs » aux astuces aléatoires du menu de recherche |
Associations utiles
Renommer le chemin /docs
Si vous avez accès à votre serveur, vous pouvez modifier le chemin de votre lien /docs en ajoutant une variable d’environnement DISCOURSE_DOCS_PATH: à votre fichier app.yml :
Pour que le changement prenne effet, vous pouvez soit exécuter ./launcher rebuild app, soit, comme il s’agit d’une variable d’environnement, exécuter ./launcher destroy app && ./launcher start app pour minimiser les temps d’arrêt. Vous trouverez plus d’informations à ce sujet ici : Set Environmental Variables
Vous voudrez peut-être également modifier le texte d’affichage du site pour qu’il corresponde. Vous pouvez rechercher toutes les occurrences de « docs » depuis votre page /admin/customize/site_texts, mais les principales sont :
- js.docs.title
- js.sidebar.docs_link_text
Hébergé par nous ? Le renommage du chemin
/docsn’est disponible que sur notre plan Entreprise. Veuillez nous contacter si vous souhaitez en savoir plus.
Historique du développement
Le plugin Docs est une continuation du Composant de thème Knowledge Explorer.