Discourse 문서

:warning: 이 플러그인은 실험 단계인 Doc Categories 플러그인으로 대체되어 종료됩니다. 새 플러그인이 더 이상 실험 단계로 간주되지 않을 때까지 Docs에 대한 지원을 계속합니다.

:discourse2: 요약 Discourse Docs는 지식 베이스 토픽을 찾고 필터링할 수 있는 기능을 제공합니다.
:hammer_and_wrench: 저장소 링크 https://github.com/discourse/discourse-docs
:open_book: 설치 가이드 Discourse에서 플러그인 설치 방법

기능

Discourse Docs 플러그인은 Discourse 포럼을 커뮤니티 주도형 지식 베이스로 변환하는 강력한 도구입니다. 사용자가 문서를 생성, 업데이트 및 큐레이션할 수 있는 전용 Docs 섹션을 제공합니다. 이 플러그인은 해당 섹션에 쉽게 접근할 수 있는 Docs 버튼을 특징으로 합니다. 이는 커뮤니티의 집단적 지식을 활용하고 중요한 정보에 대한 중앙 집중식 리소스를 제공하는 훌륭한 방법입니다.

결국, Docs는 정의된 카테고리 및/또는 태그 집합 내에서 지식 베이스 스타일의 토픽을 더 쉽게 노출할 수 있게 해줍니다.

태그별로 목록을 필터링하고, 검색 바를 통해 검색하며, 지식 탐색기 컨텍스트를 벗어나지 않고 토픽을 클릭하여 첫 번째 게시물을 볼 수 있습니다.

Discourse의 다른 곳에서 지식 베이스 토픽을 찾아야 하는 경우? 새로운 검색 헬퍼인 in:kb를 사용하세요.

설정

  1. docs enabled 설정을 켜서 플러그인을 활성화합니다.

  2. docs categoriesdocs tags 설정에 카테고리와 태그를 추가합니다.

  3. 내비게이션 메뉴에서 Docs 링크를 찾습니다.

  1. 지식에 대한 더 쉬운 접근으로 수익을 얻으세요!

설정 항목

이름 설명
docs enabled Docs 플러그인 활성화
docs categories docs에 포함할 카테고리 슬러그 목록
show tags by group 태그 그룹을 사용하여 태그를 조직합니다. 관련 태그를 분류하기 위해 그룹을 생성합니다.
docs tag groups 그룹별로 태그를 표시하는 데 사용되는 태그 그룹
docs tags docs에 포함할 태그 목록
docs add solved filter 해결된 토픽에 대한 필터를 추가합니다 – Discourse Solved가 설치되고 활성화되어 있어야 합니다
docs add to top menu Docs 뷰로 이동하기 위한 링크를 상단 메뉴에 추가합니다
docs add search menu tip 검색 메뉴의 랜덤 팁에 “in:docs” 팁을 추가합니다

유용한 페어링

/docs 경로 이름 변경

서버에 액세스 권한이 있는 경우, app.ymlDISCOURSE_DOCS_PATH: 환경 변수를 추가하여 /docs 링크의 경로를 변경할 수 있습니다:

변경 사항을 적용하려면 ./launcher rebuild app을 실행하거나, 환경 변수이므로 다운타임을 최소화하기 위해 ./launcher destroy app && ./launcher start app을 실행할 수 있습니다. 이에 대한 자세한 내용은 여기 - Set Environmental Variables 에서 확인할 수 있습니다.

사이트 표시 텍스트도 일치하도록 변경하는 것이 좋습니다. /admin/customize/site_texts 페이지에서 'docs’의 모든 인스턴스를 검색할 수 있지만, 주요 항목은 다음과 같습니다:

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

:discourse2: 우리가 호스팅하고 있나요? /docs 경로 이름 변경은 Enterprise 플랜에서만 사용할 수 있습니다. 더 알고 싶으시다면 우리에게 연락해 주세요.

개발 역사

Docs 플러그인은 Knowledge Explorer 테마 컴포넌트의 연속이었습니다.

95개의 좋아요
Discourse Doc Categories
Using Posts as a Wiki?
Using Discourse as a internal Knowledge Base / Intranet
Is anyone working on a Discourse Wiki?
Documentation Library
Community glossary?
The Docs button on meta.discourse
Memberful opinions?
Filtering by multiple tags
Subcategories and tag groups layout
Discourse Docs + Pavilion Layouts Plugin
[Paid] Parent/Child Tagging System + Docs Plugin Group Tagging
Docs page in Discourse
Mirrored topic: same topic in two categories
Sidebar for Subcategories
Published page not visible?
Nest subcategories under their parent categories in the sidebar
File/Document Repository?
Creating user guides for your community
Allow plugins (like docs) to add top-level links in sidebar (rather than hide them in More...)
FAQs, less thread-y more article-y
Email list server?
Recommnded plugins for supporting a tech community run by a big enterprise?
Is it possible to display the thumbnails in Docs?
Customize docs plugin text link
Install discourse doc plugin from Git is failed
Advice on a support forum
Knowledge Base
Knowledge Base
Grow my community
Published topic with a link to itself in the forum?
Topic List Thumbnails don't play well with Docs
How-to use Discourse for managing a collaborative newsletter?
Is it possible to restrict certain “docs” to appear based on the user’s groups?
Pinning a post to the top of the topic
Knowledge Base
Discourse has slowly been solving a fatigue I didn't realize I had
Documentation in a Discussion forum
Discourse docs search error, 500 error
Discourse docs search error, 500 error
Discourse Docs Plugin – Topics Not Updating in Docs Page
Forum not working after update – what’s missing?
What is this component?
Making my discourse site look a certain way
Time tracking using Discourse?
Back button behavior on docs
Topic List Previews (TLP)
Workspace Views
New documentation plugin in development
Discourse Category Lockdown
Is anyone here using their Discourse instance as their entire website?
Question Answer Plugin
How to make the recommanded topics collection
New homes for official and community documentation
Is it possible to show tags in place of subcategories?
Disable auto-scroll for certain topics?
Implementing KCS
How can I compare arbitrary revisions of a post?
How to create a page like the official Discourse docs?
Option to use "Docs view" when accessing Docs category from anywhere in Discourse
DiscoTOC - automatic table of contents
When a thread is too important to lose
About this Community and the Docs
Ability to Create Private Templates
Tips into building a community aside a variety of already existing tools

Hi Discourse community,

I got below error when executing the spec. I didn’t change any files. Can I ignore this error?

➜  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

Did you manage to resolve this @Hyan?

3 posts were split to a new topic: How can I get a table of contents for my docs?

Hey Sam, wouldn’t it make sense from SEO perspective the rel=canonical of topics to point to the original topic? E.g. Dark/Light Mode Toggle - theme-component - Docs - Discourse MetaDark/Light Mode Toggle - theme-component - Discourse Meta? I wonder if the two versions of the page don’t cannibalize each other in google’s algorithms.

1개의 좋아요

Yes, absolutely we should do something there

1개의 좋아요

Sorry @JammyDodger I haven’t got a chance to run the Spec these days. I don’t focus on the work related to Discourse Docs but other stuff these days. But will let you know when I get any chance.

2개의 좋아요

Is there a way to change the icon next to the Docs in the Hamburger Menu from the link/chain to something else?

This plugin is great for having all our document categories all in one place - removing the need for them to also be listed in the Categories list (thanks Discourse Category Hider). However we have noticed an issue:

Within the Docs Plugin/screen you cannot edit existing documents or create new ones - meaning you have to go to the original category, to find the topic/document to edit it…meaning you have to have the document accessible in more than one place.

Is there a way to enable topic/document editing (if the user is in the right User Group) within the Docs plugin?

Does it work to use the “view the discussion on this topic” link at the bottom to navigate to that topic and edit it?

1개의 좋아요

Hi, I have an issue that’s real annoying and I do not know why it’s happening.

When i create a doc it goes to the document area and works as its suppose to, however if the document is edited in anyway the docs listing topic document layout switches back to the default discourse topic layout upon click and not show the actual document layout.

I’ve noticed after a few minutes it reverts back to the topic document layout and looks as its supposed to, is there anything that could be causing this?

Note i also use the theme component “Topic Thumbnails” and set to docs thumbnail mode “list”

Found the issue, apparently if I use Topic List Excerpts or Topic lists Thumbnails theme component the clickable href is for the discourse topic page and not the KB docs?topic=xxx so I’m being redirected to discourse topics.

Is there a way to maintain the url path on the docs to docs @sam or should reach out to @david ?

Hi,

Our users recently noticed a minor stylish issue: when the browser has less viewport width, the content of each docs post will overflow, such as in the following screenshot:

I wonder if it would be better to automatically collapse the sidebar, if the viewport is less than ideal; however, even if I collapsed the sidebar, the content would still overflow.

Thanks for the wonderful addon. One question though: is there an option to remove the link from the context hamburger menu? I added it manually in the always-visible section (as we want to use this functionality to showcase longform user-created content like articles etc) and now ended up with it showing up twice:

Both options with lighter background lead to /docs

I think you can hide it with some CSS here:

.sidebar-section-link-wrapper[data-list-item-name="docs"] {
    display: none;
}
1개의 좋아요

Worked perfectly! Thank you very much!

any chance we can have an option to integrate the comments on a docs page instead of linking to the post and then being able to comment?

1개의 좋아요

I revisited the same link on a device with the same viewport width. While there was still overflow before collapsing the sidebar, I found that after collapsing it, there is no overflow, and the display is normal and aesthetically pleasing.

I’m surprised that the default search order in Docs is not “Relevance” but “Activity Date”.

Is it possible to search by relevance?

2개의 좋아요

Today i post some topic on Docs Category, but those topic not Display in Docs page. I turn off docs plugin and turn theme back on again But those topics untill Not display.
Thank you!