GitHub 연동 서비스를 사용하면 GitHub에서 공동 작업으로 테마를 개발하고 유지한 후 지식 관리자에서 테마를 미리 보거나 게시할 수 있습니다. 연동 서비스를 설정하려면 반드시 테마가 GitHub에 저장되어 있는지 확인한 다음 지식 관리자에서 연동 서비스를 설정하세요.

사용 중인 플랜
모든 Suite Growth, Professional, Enterprise 또는 Enterprise Plus
지원 지식 Professional 또는 Enterprise

요약: ◀▼

GitHub의 헬프 센터 테마를 지식 관리에 연결한 다음 업데이트를 미리 보거나 게시할 수 있습니다. 설정을 위해서는 테마 저장소에 하나의 테마가 있어야 하며 저장소 루트에 manifest.json 파일이 있어야 합니다. 이 연동 서비스는 공동 작업 테마 관리, 브랜치 기반 테스트, GitHub Enterprise Cloud를 지원하지만 GitHub Enterprise Server는 지원하지 않습니다.

위치: 지식 관리 > 디자인 사용자 지정() > 테마 추가 > GitHub에서 추가

GitHub 연동 서비스를 사용하면 GitHub에서 공동 작업으로 테마를 개발하고 유지한 후 지식 관리자에서 테마를 미리 보거나 게시할 수 있습니다. 연동 서비스를 설정하려면 반드시 테마가 GitHub에 저장되어 있는지 확인한 다음 지식 관리자에서 연동 서비스를 설정하세요.

참고: 헬프 센터와의 GitHub 연동 서비스는 GitHub Enterprise Server를 지원하지 않고 GitHub Enterprise Cloud를 지원합니다. GitHub Enterprise Server를 사용하는 경우에는 대안으로 Guide 테마 API를 사용할 수 있습니다.

GitHub 연동을 설정하려면 지식 관리자여야 합니다.

이 문서에서 다루는 주제는 다음과 같습니다.
  • GitHub에서 테마 준비하기
  • 연동 서비스 설정하기

GitHub에서 테마 준비하기

지식 관리자에서 연동 서비스를 설정하기 전에 테마가 GitHub에 있는지 확인해야 합니다. Git 및 GitHub를 처음 사용하는 경우에는 이 튜토리얼을 확인해 보세요. 테마가 이미 GitHub에 있고 다음 요구 사항을 충족하는 경우에는 연동 서비스 설정하기를 참조하세요.

연동 서비스를 위해 GitHub 저장소에 대한 다음과 같은 요구 사항이 있습니다.

  • GitHub 저장소의 루트에 매니페스트 파일이 있어야 합니다.

    GitHub 저장소의 루트에 manifest.json 파일이 있어야 테마를 추가할 수 있습니다. 지식 관리자로 가져올 때 무시되는 도구와 같은 추가 파일을 여전히 포함할 수 있습니다.

  • GitHub 저장소에는 하나의 테마만 있을 수 있습니다.

    각 저장소에서 하나의 테마만 관리할 수 있습니다. 테마 가져오기 중 브랜치 옵션을 사용하여 테마의 변형을 사용해 볼 수 있습니다.

GitHub 저장소에 테마를 가져오려면 다음과 같이 하세요.

  • 현재 테마가 없는 경우에는 Copenhagen 테마 저장소를 분기하고 테마 구축을 시작할 수 있습니다. 이로써 Copenhagen 테마의 개선 사항을 쉽게 향후 테마에 포팅할 수 있습니다.
  • 테마가 지식 관리에 있는 경우 테마를 다운로드한 다음 GitHub 저장소를 만들어(아직 없는 경우) 테마를 GitHub 저장소에 푸시합니다.
  • 테마가 지식 관리자 또는 GitHub에 없는 경우에는 GitHub 저장소를 만들고(아직 없는 경우) 테마를 GitHub 저장소에 푸시합니다.

GitHub에서 테마를 준비했으면 연동 서비스를 설정할 준비가 된 것입니다.

연동 서비스 설정하기

GitHub 연동 서비스를 설정하려면 반드시 테마가 GitHub에 저장되어 있는지 확인한 다음 GitHub에서 지식 관리자로 테마를 가져와야 합니다. 이 일회성 가져오기는 테마와 GitHub 간의 연결을 설정합니다.

연동 서비스를 설정한 후에는 GitHub에서 테마 작업을 한 다음 준비가 되면 지식 관리자에서 테마를 업데이트합니다. 그런 다음 지식 관리자에서 실시간으로 테마를 미리 보거나 게시할 수 있습니다.

헬프 센터 테마와 GitHub 연동 서비스를 설정하려면 다음과 같이 하세요.

  1. GitHub에서 테마를 준비했는지 확인합니다.
  2. 지식 관리의 사이드바에서 디자인 사용자 지정()을 클릭합니다.

    테마 페이지가 열립니다.

  3. 오른쪽 위에 있는 테마 추가를 클릭합니다.
  4. GitHub에서 추가를 클릭합니다.

  5. 저장소의 URL을 입력하고, 기본 브랜치가 아닌 다른 브랜치에서 가져오려면 브랜치 이름을 입력(선택 사항)한 다음 가져오기를 클릭합니다.

  6. 메시지가 표시되면 GitHub에 로그인하고 안내에 따라 Zendesk 테마 가져오기 GitHub 앱을 설치합니다.

    저장소가 있는 GitHub 계정 또는 조직을 선택한 다음 앱이 액세스할 수 있는 저장소를 선택합니다. 조직이나 연결 중인 저장소의 관리자는 바로 앱을 설치할 수 있습니다. 필요한 관리자 권한이 없는 경우 GitHub에서 조직 관리자에게 설치 요청을 보냅니다. 관리자가 앱을 설치하고 저장소에 대한 액세스 권한을 부여한 후에도 연동을 계속할 수 있습니다.

가져오기가 완료되면 테마 페이지에 테마 축소판 이미지가 나타납니다. 문제가 있으면 헬프 센터 테마용 GitHub 연동 서비스 문제 해결하기를 참조하세요.

연결을 설정한 후에는 GitHub에서 테마를 관리하고 필요에 따라 지식 관리자에서 테마를 업데이트합니다 .

번역 고지 사항: 본 문서는 콘텐츠에 대한 기본적인 이해를 제공하기 위해 자동 번역 소프트웨어를 사용하여 번역되었습니다. 정확한 번역을 제공하고자 합당한 노력을 기울였으나 Zendesk는 번역의 정확성을 보장하지 않습니다.

번역된 문서에 포함된 정보의 정확성과 관련하여 질문이 있으시면 문서의 공식 버전인 영문 버전을 참조하시기 바랍니다.

Zendesk 제공