Guide 테마와 GitHub 연동 설정하기

빠른 경로: Guide 관리자 > 디자인 사용자 지정 아이콘 > 테마 추가 > GitHub에서 추가

GitHub 연동 서비스를 통해 GitHub에서 공동으로 테마를 개발하고 유지 관리한 다음 Guide에서 미리 보거나 게시할 수 있습니다. 연동 서비스를 설정하려면 테마가 GitHub에 저장되어 있는지 확인한 다음 Guide에서 연동 서비스를 설정합니다.

참고: Guide와의 GitHub 연동 서비스는 GitHub Enterprise를 지원하지 않습니다. 대안으로 Guide 테마 API를 사용하세요.

Guide 관리자만 Guide에서 GitHub 연동 서비스를 설정할 수 있습니다.

이 문서에서 다루는 주제는 다음과 같습니다.

• GitHub에서 테마 준비하기
• 연동 서비스 설정하기

GitHub에서 테마 준비하기

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

연동 서비스는 GitHub 저장소에 대해 다음과 같은 요건을 가집니다.

• 메니페스트 파일은 GitHub 저장소의 루트이어야 함

  Guide가 테마를 추가할 수 있으려면 manifest.json 파일이 GitHub 저장소의 루트에 있어야 합니다. 툴링 등의 추가 파일을 추가할 수 있지만 Guide에 가져올 때 무시됩니다.

• GitHub 저장소는 한 개의 테마만 가질 수 있음

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

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

• 현재 테마를 가지고 있지 않다면 Copenhagen 테마 저장소를 포크하여 테마를 구축하기 시작합니다. 이로써 나중에 Copenhagen 테마의 향상된 기능을 쉽게 자신의 테마로 포팅할 수 있습니다.
• Guide에 테마가 있는 경우에는 Guide에서 테마를 다운로드한 다음 GitHub 저장소를 만들고(아직 없는 경우) 테마를 GitHub 저장소에 푸시합니다.
• Guide나 GitHub에 테마가 없는 경우에는 GitHub 저장소를 만들고(아직 없는 경우) 테마를 GitHub 저장소에 푸시합니다.

GitHub에서 테마를 준비했으면 이제 Guide에서 연동 서비스를 설정하면 됩니다.

연동 서비스 설정하기

GitHub 연동 서비스를 설정하려면 테마가 GitHub에 저장되어 있는지 확인한 다음 GitHub에서 Guide로 테마를 가져옵니다. 이러한 일회성 가져오기는 테마와 GitHub 사이의 연결을 설정합니다.

연동 서비스를 설정한 후에는 GitHub에서 테마에 대한 작업을 한 다음 준비가 되었으면 Guide에서 테마를 업데이트합니다. Guide에서 테마를 라이브로 미리 보거나 게시할 수 있습니다.

Guide 테마와 GitHub 연동을 설정하려면 다음과 같이 하세요.

1. GitHub에서 테마가 준비되어 있도록 합니다.
2. Guide의 사이드바에서 디자인 사용자 지정 아이콘()을 클릭합니다.

   테마 페이지가 열립니다.

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

   

5. 저장소의 URL을 입력하고, 기본 브랜치가 아닌 다른 브랜치로부터 가져오려는 경우(선택 사항) 브랜치 이름을 입력한 다음 가져오기를 클릭합니다.
6. 메시지가 표시되면 GitHub로 로그인한 다음 Zendesk에 권한 부여를 클릭합니다.

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

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