Skip to content

Preview Docs

Jump to bottom
임기정 edited this page Dec 12, 2023 · 11 revisions

Service 배포 전에 내부 구성원들에게 공유 목적으로 사용할 preview 브랜치 사용법 안내합니다. 배포 된 내용은 아래 링크에서 확인할 수 있습니다.

배포 링크: https://whatap.github.io/whatap-docs

브랜치 배포 구성도

image
  • main 브랜치는 https://docs.whatap.io 페이지로 배포됩니다.
  • preview 브랜치는 https://whatap.github.io/whatap-docs 페이지로 배포됩니다.
  • preview 브랜치는 국어(KOR)만 배포합니다.
  • main 브랜치 Service 배포 완료 후에는 preview 브랜치로 병합(merge)합니다.

preview 브랜치: docusaurus.config.js 설정

preview 브랜치의 docusaurus.config.js 파일의 설정을 다음과 같이 유지해야 합니다. main 브랜치 병합(merge) 후 다음 항목을 확인하세요.

  • baseURL: '/whatap-docs/'

    preview 도메인은 서브 도메인을 사용하기에 위와 같이 설정해줘야 합니다.

  • announcementBar

    announcementBar: {
  id: 'moniday-banner',
  content: '<div id="moniday-banner">This is unreleased documentation for WhaTap Docs.</div>',
  backgroundColor: 'none',
  textColor: '#ffffff',
  isCloseable: true,
},

배포 방법

Web browser

preview 도메인의 배포 방법은 GitHub의 Actions 기능과 Pages 기능을 이용합니다. 배포 브랜치는 'gh-pages'입니다. GitHub 액션 기능을 실행해 빌드된 콘텐츠를 'gh-pages' 브랜치로 업데이트하고, 해당 브랜치를 기준으로 웹 페이지를 구성합니다.

image

  1. whatap-docs 저장소에서 Actions 메뉴로 이동하세요.

  2. 왼쪽 메뉴에서 Deploy to GitHub Pages 메뉴를 선택하세요.

  3. Run workflow 버튼을 선택하세요.

    image

  4. Branch는 preview로 선택한 다음 Run workflow 버튼을 클릭하세요.

    image

  5. 화면 목록에 Deploy to GitHub Pages 항목이 추가되며 배포가 진행됩니다.

  6. Deploy to GitHub Pages 배포가 완료된 이후에는 왼쪽 메뉴의 pages-build-deployment에서 한번 더 배포를 진행합니다.

모든 과정이 완료되면 https://whatap.github.com/whatap-docs 페이지에서 내용을 확인하세요. 전체 배포 시간은 약 20분 정도 소요됩니다.

CLI

  1. GitHub CLI 설치: brew install gh

  2. GitHub 인증: gh auth login

    화면 안내에 따라 진행하세요.

  3. 위 과정을 모두 완료한 후에는 루트 디렉터리에 run-preview-deploy.sh 배치 파일을 실행하거나 다음 명령어를 실행하세요.

    gh workflow run preview.yml --ref preview

주의 사항

  • preview 브랜치는 국어(KOR)만 배포합니다. 영어 또는 일본어가 필요한 경우 Actions 기능을 수정해야 합니다.
  • preview 브랜치를 main 브랜치로 병합하지 마세요.
  • main 브랜치의 서비스 배포 후에는 preview 브랜치로 병합 진행합니다.
  • main 브랜치를 preview 브랜치로 병합한 후에는 docusaurus.config.js 파일 설정을 확인하세요.
Clone this wiki locally