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:
При выполнении спецификации я получил ошибку ниже. Я не менял никаких файлов. Можно ли игнорировать эту ошибку?
➜ 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, у меня в последнее время не было возможности запустить Spec. Сейчас я занимаюсь не работой, связанной с Discourse Docs, а другими задачами. Но я дам тебе знать, как только появится возможность.
Этот плагин отлично подходит для того, чтобы разместить все категории документов в одном месте, избавив от необходимости дублировать их в списке категорий (спасибо плагину Discourse Category Hider). Однако мы обнаружили проблему:
В плагине Docs / на экране Docs невозможно редактировать существующие документы или создавать новые. Это означает, что вам приходится переходить в исходную категорию, чтобы найти тему/документ для редактирования… то есть документ должен быть доступен более чем в одном месте.
Существует ли возможность включить редактирование тем/документов (если пользователь принадлежит к правильной группе пользователей) непосредственно внутри плагина Docs?
Привет, у меня есть довольно раздражающая проблема, и я не понимаю, почему она возникает.
Когда я создаю документ, он попадает в раздел документов и работает как положено. Однако, если документ каким-либо образом редактируется, макет списка тем документов переключается обратно на стандартный макет темы Discourse при клике, и не отображается фактический макет документа.
Я заметил, что через несколько минут он снова возвращается к макету темы документа и выглядит так, как должно быть. Не могли бы вы подсказать, что может быть причиной этого?
Примечание: я также использую компонент темы «Миниатюры тем» и установил режим миниатюр документов в «список».
Нашёл проблему: похоже, что при использовании темы «topic-list-excerpts» (Topic List Excerpts) или компонента темы «Topic lists Thumbnails» (Topic List Thumbnails) ссылка href ведёт на страницу темы Discourse, а не на документацию KB?topic=xxx, из-за чего происходит перенаправление на темы Discourse.
Есть ли способ сохранить путь URL в документации на @sam, или стоит обратиться к @david?
Наши пользователи недавно заметили небольшую проблему со стилями: когда ширина окна браузера меньше, содержимое каждого поста в документации выходит за пределы, как показано на следующем скриншоте:
Мне интересно, не лучше ли автоматически сворачивать боковую панель, если ширина окна недостаточна; однако даже после сворачивания боковой панели содержимое всё равно выходит за пределы.
Спасибо за замечательное дополнение. Но у меня один вопрос: есть ли возможность убрать ссылку из контекстного меню с «гамбургером»? Я добавил её вручную в секцию «всегда видна» (так как хотим использовать эту функцию для демонстрации длинного пользовательского контента, например, статей и т.д.), и теперь она отображается дважды:
Я снова проверил ту же ссылку на устройстве с той же шириной области просмотра. Хотя до сворачивания боковой панели переполнение всё ещё присутствовало, я обнаружил, что после его сворачивания переполнения нет, и отображение выглядит нормально и эстетично.
Сегодня я опубликовал несколько тем в категории «Документация», но они не отображаются на странице «Документация». Я отключил плагин документации и снова включил тему, но темы всё ещё не отображаются.
Спасибо!
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.
