 |
요약 | Discourse Doc Categories 플러그인은 특정 카테고리를 문서용으로 지정하여 해당 카테고리에 추가 기능을 사용할 수 있도록 합니다. |
 |
리포지토리 링크 | https://github.com/discourse/discourse-doc-categories |
 |
설치 가이드 | Discourse에 플러그인 설치하는 방법 |
이 플러그인은 활발한 개발 단계에 있으며 아직 완전히 완성되지 않았습니다.
기능
Discourse Doc Categories 플러그인은 기존 Discourse 포럼에 구조화된 문서를 호스팅할 수 있게 해줍니다. 특정 카테고리를 문서용으로 지정하고, 특정 문서 주제를 찾는 것을 더 쉽게 만드는 기능을 제공하여 작동합니다.
Documentation 카테고리에서 이를 작동하는 모습을 볼 수 있습니다.
카테고리를 문서 저장소로 지정하면 해당 카테고리에서 다음 기능이 활성화됩니다:
- 카테고리 내 모든 문서 주제를 위한 인덱스로 사용할 지정된 주제
- 카테고리 내 다른 주제 간 탐색을 위한 새 사이드바(내장 필터링 및 검색 기능 포함)
- 인덱스 주제의 무결성을 유지하는 데 도움이 되는 새 보고서
또한, 이 플러그인은 폐지된 Docs 플러그인에서 마이그레이션하는 사이트를 위한 리다이렉트를 처리합니다. 해당 플러그인에서 온 문서 링크는 기존 주제 URL로 리다이렉트되며, 이전 문서 홈페이지를 주요 문서 카테고리로 리다이렉트하는 설정이 있습니다.
구성
구성 설정은 example.discourse.com/admin/site_settings/category/doc_categories에서 사용할 수 있습니다. 여기에서 다음 설정을 찾을 수 있습니다:
doc categories enabled: Doc Categories 플러그인을 활성화하려면 선택하십시오.doc categories docs legacy enabled: 폐지된 Docs 플러그인에서 마이그레이션한 경우 이 설정을 선택하십시오.doc categories homepage: 이전 설정이 활성화되면, 폐지된 Docs 플러그인의 랜딩 페이지가 이 URL로 리다이렉트됩니다.
문서로 사용할 카테고리를 지정하려면 인덱스 주제를 할당하십시오. 이를 수행하려면 카테고리 페이지에서 
아이콘을 클릭하여 카테고리 설정을 엽니다. 그곳에서 ‘설정’ 링크를 클릭하고 ‘Documentation mode’ 섹션으로 스크롤하십시오. ‘Index topic’ 필드를 사용하여 카테고리의 인덱스로 사용할 주제를 지정하십시오.
인덱스 주제
문서 카테고리의 인덱스 주제는 두 가지 목적으로 사용됩니다:
- 카테고리에 포함된 모든 주제의 중앙 목록입니다.
- 이 플러그인에 포함된 사이드바는 인덱스 주제의 내용으로 채워집니다.
인덱스 주제 형식
인덱스 주제에는 원하는 모든 내용을 포함할 수 있습니다. 사이드바가 올바르게 작동하려면 문서 주제에 대한 불릿 목록(또는 여러 불릿 목록)을 포함해야 합니다. 이는 단순히 목록으로 된 주제 URL일 수 있으며, 이 경우 사이드바에는 각 문서 주제의 전체 제목이 표시됩니다.
제목이 몇 단어보다 길다면 사이드바에 전체 제목을 표시하는 것이 실용적이지 않을 수 있으므로, 특정 주제에 더 짧은 제목을 설정하려면 콜론(:)으로 이어지는 짧은 제목을 URL 앞에 붙이십시오. 콜론 앞의 모든 텍스트가 사이드바에 표시되고 주제 URL로 링크됩니다.
인덱스 주제를 섹션으로 나누고 각 섹션 위에 헤딩(수준 무관)을 사용하여 여러 목록을 사용할 수 있습니다 - 그러면 사이드바에 이 섹션으로 표시됩니다.
시작을 위한 인덱스 주제의 예시입니다:
카테고리에 대한 선택적인 간단한 설명으로 시작할 수 있습니다.
## 첫 번째 섹션
* https://discourse.example.com/t/topic-title/12
* https://discourse.example.com/t/another-topic-title/34
* 짧은 제목: https://discourse.example.com/t/topic-with-a-long-title/56
* 다른 제목: https://discourse.example.com/t/another-topic-with-a-long-title/78
## 두 번째 섹션
* 주제 제목: https://discourse.example.com/t/documentation-topic/98
* https://discourse.example.com/t/new-topic/76
이 예시는 다음과 같은 문서 사이드바를 출력합니다:
문서 카테고리 인덱스가 작동하는 예시를 보려면 Documentation > Site Management 인덱스 주제를 참조하십시오: https://meta.discourse.org/t/site-management-index/308032
인덱스 주제 유지 관리
카테고리의 콘텐츠가 추가, 삭제 또는 편집되어도 인덱스 주제가 자동으로 업데이트되지는 않지만, 플러그인에는 인덱스 주제 내에서 불일치가 있는 부분을 강조하는 새 보고서가 포함되어 있습니다.
-
인덱스에 없는 주제:
example.discourse.com/admin/reports/doc_categories_missing_topics
이 보고서는 문서 카테고리에 있지만 인덱스에 추가되지 않은 주제를 표시합니다. -
불필요한 항목:
example.discourse.com/admin/reports/doc_categories_extraneous_items
이 보고서는 인덱스에 포함되어 있지만在那里있어야 할 것 같지 않은 항목을 표시합니다. 보고서는 주제가 보고서에 포함된 이유를 표시합니다 - 예를 들어, 삭제되었거나 인덱스 주제가 포함된 카테고리와 다른 카테고리에 있는 경우입니다.
추가 정보
검색어에 문자열 in:docs를 추가하면 문서로 표시된 모든 카테고리(즉, 인덱스 주제가 할당된 카테고리)를 검색합니다.
인덱스의 최대 항목 수는 Max oneboxes per post 사이트 설정으로 설정되며, 기본값은 50입니다. 인덱스 항목이 50개 이상 필요하면 해당 설정의 수를 증가시키십시오.
)
I was exploring moving my docs to 
