카우치베이스에서 문서화가 더 나은 방향으로 변화하고 있습니다. Matt Carabine과 문서 팀은 빌드 프로세스, 백포팅 및 검토를 개선하기 위해 노력해 왔습니다. 그리고 그 과정에서 문서화에 기여하는 것이 더 쉬워졌습니다.
문서에 기여하기
Couchbase 문서는 오픈 소스이지만 최근까지 여러 가지 문제가 있었습니다. 큰 변경을 하거나 간단한 오타만 수정하려는 경우 이러한 문제 중 하나 이상에 직면하게 됩니다:
- 변경하려면 어디에서 찾아야 하나요?
- 어떤 파일을 변경하나요?
- 내가 보고 있는 문서 페이지에 어떤 파일이 매핑되나요?
- 어떻게 변경하나요?
문서 URL에서 Github 리포지토리의 특정 파일로 이동하는 방법이 항상 명확하지는 않았습니다.
이제 변경되었습니다. 문서의 페이지를 방문하면 각 페이지에 'GitHub에서 편집' 링크가 표시됩니다. 이 링크를 클릭하면 파일을 직접 편집할 수 있는 GitHub로 이동합니다(처음 사용하는 경우 포크를 만들라는 메시지가 표시됩니다).
예
먼저 정상 장애 조치 사용 페이지를 참조하세요.
그런 다음 'GitHub에서 편집' 링크를 클릭합니다.
이 시점에서 여러분은 GitHub에 있습니다. 이전에 Git/GitHub를 사용해 본 적이 있다고 가정하면 이 프로세스의 나머지 부분은 익숙할 것입니다.
아직 포크를 만들지 않았다면 만들라는 메시지가 표시됩니다.
그런 다음 변경할 수 있는 편집 화면이 표시됩니다.
변경한 후에는 "파일 변경 제안"을 클릭합니다. 변경 사항이 표시되고 풀 리퀘스트를 만들 수 있습니다.
기여 가이드
문서에 기여하는 방법에 대한 기본 과정입니다. 여기에는 카우치베이스 서버 문서에 기여하는 방법에 대한 전체 가이드.
이 가이드는 마크다운으로 작성되었지만, 카우치베이스 서버 문서에서는 다윈 정보 타이핑 아키텍처(DITA) 마크업 언어.
간단한 오타 수정을 위해서는 DITA에 대해 많이 알 필요가 없지만, 더 심층적인 편집을 위해서는 다음과 같은 구문 및/또는 편집 도구에 익숙해져야 합니다. 산소.
문서 기여
이미 기여해주신 커뮤니티 분들께 감사드립니다! 이 새로운 시스템이 도입된 지 몇 달 밖에 되지 않았지만 이미 훌륭한 기여가 있었습니다. 모두에게 감사의 인사를 전합니다:
- EUNOSM3용 #1180 - 캐싱 레이어 아키텍처 관리를 위한 쇼트데스크 개선
- atom992용 #1365 - cbexport에 대한 플래그 수정하기
- Sir4ur0n #1366 - N1QL 오타 수정
- ptorsson #1414 - 일부 Go SDK 예제 수정
- 마크 틱너 #1457 - REST API 서비스 매개변수에 대한 문서 추가
- ecejnj42용 #1585 - 내구성 영역에서 잘못 배치된 옵션 수정
- 랍딜 #1632 - Go N1QL 예제의 오타 수정
- GauthamBanasandra #1696 - 하위 문서 영역의 일부 문법 수정
- 옥시락스용 #1725 - cbbackupmgr에 대한 설정 수정하기
이렇게 많은 분들이 이렇게 빨리 큰 도움을 주셨다니 놀랍습니다! 더 나은 문서를 만드는 데 도움을 주신 모든 분들께 감사드립니다.
어떻게 여기까지 왔나요?
기여를 더 쉽게 하기 위해 빌드 프로세스를 개선해야 했습니다. 이전에는 소스를 가져오고, 로컬에서 빌드하고, 결과를 압축하고, 서버로 FTP로 전송하고, 하나 이상의 느린 빌드 서버 작업을 수동으로 실행하는 등 수많은 수동 단계가 필요했습니다. 이제 풀 리퀘스트에서 빌드 단계가 훨씬 더 빠르게 진행되고 미리보기가 빠르게 생성되는 것을 볼 수 있습니다.
콘텐츠 검토 기능도 개선되었습니다. 이전에는 미리보기가 한 위치에서만 가능했습니다. 동시에 검토할 수 없었습니다. 이는 느린 수동 빌드와 결합되어 불편함을 초래했고, 외부 변경 사항은 물론 모든 변경 사항을 검토하기 어려웠습니다.
마지막으로 다른 버전의 Couchbase Server 문서로 백포트하는 것도 문제였습니다. 문서는 각 버전별로 별도의 브랜치에 저장되므로 4.6에서 문제가 발생하여 수정된 경우 4.5 등에도 적용될 수 있습니다. 이는 매우 수동적인 프로세스이지만 백포팅을 자동화하기 위해 @cb-docs-robot이 만들어졌습니다(위의 많은 예제에서 볼 수 있습니다).
어떻게 지내고 있나요?
또 한 가지 추가된 기능은 브라우저에서 바로 문서에 대한 피드백을 제공할 수 있는 기능입니다.
간단히 "이 페이지에 대한 피드백" 버튼을 찾아 클릭한 후 피드백을 작성하세요.
요약
이러한 문서 개선은 내부적으로나 외부적으로나 도움이 될 것입니다. 문서를 사용하는 데 있어 불편함을 덜고 더 즐거운 경험을 하실 수 있기를 바랍니다. 여러분의 피드백을 환영합니다! 다음 링크를 통해 카우치베이스 문서 에서 확인하세요.
