이 플러그인은 실험 단계인 Doc Categories 플러그인으로 대체되어 종료됩니다. 새 플러그인이 더 이상 실험 단계로 간주되지 않을 때까지 Docs에 대한 지원을 계속합니다.
 |
요약 | Discourse Docs는 지식 베이스 토픽을 찾고 필터링할 수 있는 기능을 제공합니다. |
 |
저장소 링크 | https://github.com/discourse/discourse-docs |
 |
설치 가이드 | Discourse에서 플러그인 설치 방법 |
기능
Discourse Docs 플러그인은 Discourse 포럼을 커뮤니티 주도형 지식 베이스로 변환하는 강력한 도구입니다. 사용자가 문서를 생성, 업데이트 및 큐레이션할 수 있는 전용 Docs 섹션을 제공합니다. 이 플러그인은 해당 섹션에 쉽게 접근할 수 있는 Docs 버튼을 특징으로 합니다. 이는 커뮤니티의 집단적 지식을 활용하고 중요한 정보에 대한 중앙 집중식 리소스를 제공하는 훌륭한 방법입니다.
결국, Docs는 정의된 카테고리 및/또는 태그 집합 내에서 지식 베이스 스타일의 토픽을 더 쉽게 노출할 수 있게 해줍니다.
태그별로 목록을 필터링하고, 검색 바를 통해 검색하며, 지식 탐색기 컨텍스트를 벗어나지 않고 토픽을 클릭하여 첫 번째 게시물을 볼 수 있습니다.
Discourse의 다른 곳에서 지식 베이스 토픽을 찾아야 하는 경우? 새로운 검색 헬퍼인 in:kb를 사용하세요.
설정
-
docs enabled설정을 켜서 플러그인을 활성화합니다. -
docs categories및docs tags설정에 카테고리와 태그를 추가합니다. -
내비게이션 메뉴에서 Docs 링크를 찾습니다.
- 지식에 대한 더 쉬운 접근으로 수익을 얻으세요!
설정 항목
| 이름 | 설명 |
|---|---|
| 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.yml에 DISCOURSE_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
/docs경로 이름 변경은 Enterprise 플랜에서만 사용할 수 있습니다. 더 알고 싶으시다면 우리에게 연락해 주세요.
개발 역사
Docs 플러그인은 Knowledge Explorer 테마 컴포넌트의 연속이었습니다.