Documents Discourse

[Discourse]

Ce plugin est retiré au profit du plugin expérimental Doc Categories. 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 les sujets de la base de connaissances
	Lien vers le dépôt	https://github.com/discourse/discourse-docs
	Guide d’installation	Comment installer des plugins dans Discourse

Comme il s’agit d’un plugin official maintenu par l’équipe Discourse, les demandes de Support, de rapport de bug, d’amélioration de l’expérience utilisateur (ux) et de nouvelles fonctionnalités (#feature) peuvent être soumises dans les catégories respectives ici sur Meta, et étiquetées avec le tag du plugin approprié. Cliquez sur un lien ci-dessous pour en démarrer un.

 Support  Bug  UX  Fonctionnalité

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 Docs dédiée 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 substance, Docs permet de faciliter la mise en avant de sujets de style base de connaissances sur un ensemble défini de catégories et/ou de tags.

Filtrez la liste par tags, 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

1. Activez le plugin en activant le paramètre docs enabled.

2. Ajoutez des catégories et des tags aux paramètres docs categories et docs tags.

3. Trouvez le lien Docs dans le menu de navigation.

4. 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 docs
show tags by group	Organiser les tags en utilisant des groupes de tags. Créez des groupes pour catégoriser les tags connexes.
docs tag groups	Les groupes de tags utilisés pour afficher les tags par groupe
docs tags	Une liste de tags à inclure dans docs
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

Discourse Docs Card Filter

Summary Discourse Docs Card Filter is to be used with the Discourse Docs Plugin and allows you to place “Cards” that act as a clickable filter for quicker filter results upon entering the /docs page by your users. Preview Preview on Discourse Theme Creator Repository Link https://github.com/discourse/discourse-docs-card-filter New to Discourse Themes? Beginner’s guide to using Discourse Themes Install this theme comp…

Renommage du 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 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. Il y a un peu 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 seraient :

• js.docs.title
• js.sidebar.docs_link_text

Hébergé par nous ? Le renommage du chemin /docs n’est disponible que sur notre plan Entreprise. Veuillez nous contacter si vous souhaitez en savoir plus.

Historique du développement

Le plugin Docs est la suite du Composant de thème Knowledge Explorer.

Hébergé par nous ? Ce plugin est disponible sur tous nos plans d’hébergement. https://www.discourse.org/plugins/docs.html

[Hyan]

Salut la communauté Discourse,

J’ai reçu l’erreur ci-dessous en exécutant le spec. Je n’ai modifié aucun fichier. Puis-je ignorer cette erreur ?

➜  discourse git:(main) ✗ LOAD_PLUGINS=1 bundle exec rspec plugins/discourse-docs/spec

Randomized with seed 57815
...................................F

Failures:

  1) Discourse Docs | Index topic excerpts when the theme modifier serialize_topic_excerpts is true shows the excerpts
     Failure/Error: expect(page).to have_css(".topic-excerpt", text: topic_1.excerpt)
       expected to find css ".topic-excerpt" but there were no matches

     [Screenshot Image]: /xxxx/discourse/discourse/tmp/capybara/failures_r_spec_example_groups_discourse_docs_index_topic_excerpts_when_the_theme_modifier_serialize_topic_excerpts_is_true_shows_the_excerpts_460.png

     ~~~~~~~ JS LOGS ~~~~~~~
     ~~~~~ END JS LOGS ~~~~

     # ./plugins/discourse-docs/spec/system/docs_index_spec.rb:52:in `block (4 levels) in <main>'
     # ./spec/rails_helper.rb:469:in `block (2 levels) in <top (required)>'

Finished in 13.16 seconds (files took 2.79 seconds to load)
36 examples, 1 failure

Failed examples:

rspec ./plugins/discourse-docs/spec/system/docs_index_spec.rb:50 # Discourse Docs | Index topic excerpts when the theme modifier serialize_topic_excerpts is true shows the excerpts

Randomized with seed 57815

[JammyDodger]

Avez-vous réussi à résoudre ce problème @Hyan ?

[tpetrov (Toni Petrov)]

Salut Sam, ne serait-il pas logique d’un point de vue SEO que le rel=canonical des sujets pointe vers le sujet original ? Par exemple, Dark/Light Mode Toggle - theme-component - Docs - Discourse Meta → Dark/Light Mode Toggle - theme-component - Discourse Meta ? Je me demande si les deux versions de la page ne se cannibalisent pas mutuellement dans les algorithmes de Google.

[sam (Sam Saffron)]

Oui, absolument, nous devrions faire quelque chose là-bas

[Hyan]

Désolé @JammyDodger, je n’ai pas eu la chance d’exécuter le Spec ces jours-ci. Je ne me concentre pas sur le travail lié à Discourse Docs mais sur d’autres choses ces jours-ci. Mais je vous ferai savoir quand j’aurai une chance.

[martyn_thomas]

Est-il possible de changer l’icône à côté de Docs dans le menu Hamburger, passant du lien/chaîne à autre chose ?

[martyn_thomas]

Ce plugin est idéal pour avoir toutes nos catégories de documents en un seul endroit - supprimant ainsi le besoin de les lister également dans la liste des catégories (merci Discourse Category Hider). Cependant, nous avons remarqué un problème :

Dans le plugin/l’écran Docs, vous ne pouvez pas modifier les documents existants ni en créer de nouveaux - ce qui signifie que vous devez aller dans la catégorie d’origine pour trouver le sujet/document à modifier… ce qui implique que le document doit être accessible à plus d’un endroit.

Y a-t-il un moyen d’activer la modification des sujets/documents (si l’utilisateur fait partie du bon groupe d’utilisateurs) dans le plugin Docs ?

[Moin]

[quote=“Martyn Thomas, post:351, topic:130172, username:martyn_thomas”]vous devez aller dans la catégorie d’origine, pour trouver le sujet/document pour le modifier
[/quote]

Est-ce que le lien « voir la discussion sur ce sujet » en bas fonctionne pour accéder à ce sujet et le modifier ?

[digitaldominica]

Salut, j’ai un problème vraiment agaçant et je ne sais pas pourquoi il se produit.

Lorsque je crée un document, il apparaît dans la zone des documents et fonctionne comme prévu. Cependant, si le document est modifié d’une quelconque manière, la mise en page du sujet de la liste des documents revient à la mise en page par défaut du sujet lors du clic et n’affiche pas la mise en page réelle du document.

J’ai remarqué qu’après quelques minutes, elle revient à la mise en page du document du sujet et ressemble à ce qu’elle devrait être. Quelque chose pourrait-il en être la cause ?

Notez que j’utilise également le composant de thème “Miniatures de sujet” et que le mode miniature des documents est défini sur “liste”.

[digitaldominica]

J’ai trouvé le problème, apparemment si j’utilise le composant de thème Topic List Excerpts ou Topic lists Thumbnails, le href cliquable pointe vers la page du sujet discourse et non vers docs?topic=xxx de la documentation, donc je suis redirigé vers les sujets discourse.

Y a-t-il un moyen de conserver le chemin d’URL sur la documentation pour docs @sam ou devrais-je contacter @david ?

[civitas_john (John Chen)]

Salut,

Nos utilisateurs ont récemment remarqué un problème stylistique mineur : lorsque le navigateur a une largeur de fenêtre d’affichage réduite, le contenu de chaque article de documentation déborde, comme dans la capture d’écran suivante :

Je me demande s’il serait préférable de réduire automatiquement la barre latérale si la fenêtre d’affichage est moins qu’idéale ; cependant, même si je réduisais la barre latérale, le contenu déborderait toujours.

[Nebthtet]

Merci pour ce merveilleux module complémentaire. Une question cependant : y a-t-il une option pour supprimer le lien du menu hamburger contextuel ? Je l’ai ajouté manuellement dans la section toujours visible (car nous voulons utiliser cette fonctionnalité pour présenter du contenu créé par l’utilisateur sous forme longue comme des articles, etc.) et il apparaît maintenant deux fois :

Les deux options avec un fond plus clair mènent à /docs

[Arkshine]

Je pense que vous pouvez le masquer avec un peu de CSS ici :

.sidebar-section-link-wrapper[data-list-item-name="docs"] {
    display: none;
}

[Nebthtet]

Ça a parfaitement fonctionné ! Merci beaucoup !

[rly]

aurions-nous une option pour intégrer les commentaires sur une page de documentation au lieu de lier vers le post et de pouvoir ensuite commenter ?

[wsxiaolin]

@civitas_john

Même lorsque je replie la barre latérale, le contenu déborde toujours.

J’ai revisité le même lien sur un appareil avec la même largeur de fenêtre d’affichage. Bien qu’il y ait encore eu un débordement avant de replier la barre latérale, j’ai constaté qu’après l’avoir repliée, il n’y a plus de débordement, et l’affichage est normal et esthétiquement agréable.

[supermathie (Michael Brown)]

Je suis surpris que l’ordre de recherche par défaut dans Docs ne soit pas « Pertinence » mais « Date d’activité ».

Est-il possible de rechercher par pertinence ?

[thaidb]

Aujourd’hui, j’ai posté un sujet dans la catégorie Docs, mais ces sujets ne s’affichent pas sur la page Docs. J’ai désactivé le plugin Docs et réactivé le thème, mais ces sujets ne s’affichent toujours pas.
Merci !