This plugin is being retired in favour of the experimental Doc Categories plugin. We will still support Docs until the new plugin is no longer considered experimental.
Summary
Discourse Docs provides the ability to find and filter knowledge base topics
The Discourse Docs plugin is a powerful tool that transforms your Discourse forum into a community-powered knowledge base. It provides a dedicated Docs section where users can create, update, and curate documentation. This plugin features a Docs button that allows easy access to this section. It’s a great way to leverage the collective knowledge of your community and provide a centralized resource for important information.
In essence, Docs allows for easier surfacing of knowledge-base style topics across a defined set of categories and/or tags.
Filter the list down by tags, search via the search bar, and click on topics to see the first post – all without leaving the context of the knowledge explorer.
For the change to take effect you can either ./launcher rebuild app or, as it’s an environment variable, you can ./launcher destroy app && ./launcher start app to minimise downtime. There’s a little more info on that here - Set Environmental Variables
You may also want to change the site display text as well to match. You can search for all instances of ‘docs’ from your /admin/customize/site_texts page, but the main ones would be:
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
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.
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 ?
[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 ?
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”.
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 ?
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.
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
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.
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 !
This plugin is being retired in favour of the experimental Doc Categories plugin. We will still support Docs until the new plugin is no longer considered experimental.
