Keyboard shortcuts

Press ← or → to navigate between chapters

Press ? to show this help

Press Esc to hide this help

문서 미리보기, 게시와 게시 취소

문서 저장소는 자신이 게시하는 콘텐츠의 기준입니다. 게시 빌드는 현재 저장소에 있는 파일만 반영하고, 이전에 게시했지만 지금은 없는 파일은 게시 사이트에서 제거합니다. 다른 저장소의 문서나 별도로 제공되는 기본 문서를 함께 삭제하는 동작은 아닙니다.

예를 들어 Product A 파일을 게시한 뒤 그 파일을 제거하고 Product B와 Product C를 추가해 다시 게시하면, 이 저장소의 게시 결과에는 B와 C만 남습니다.

편집 중 미리보기

Code Repositories에서 Markdown 파일 탭을 오른쪽 클릭하고 Split vertically 또는 Split horizontally를 선택합니다. 두 패널 중 하나에서 Toggle render Markdown을 켜면 원문과 렌더링을 나란히 볼 수 있습니다.

이 미리보기는 일반 Markdown을 사용하므로 최종 게시 화면과 완전히 같지 않습니다.

  • @title과 @description 같은 Palantir 전용 주석은 일반 텍스트로 보이고 게시 과정에서 처리합니다.
  • ordering.md로 구성한 목차와 탐색 요소는 미리보기에서 사용할 수 없을 수 있습니다.
  • HTML 안내 상자는 최종 스타일과 다르게 표시될 수 있습니다.

게시 브랜치와 빌드

사용자 정의 문서는 master 브랜치에서 빌드할 때 게시합니다. 다른 브랜치에서 작업하거나 미리 볼 수는 있지만 그 브랜치를 게시하지는 않습니다.

권장 절차는 새 작업 브랜치에서 문서를 수정하고 master 대상 Pull request로 검토받은 뒤 병합하는 것입니다. 병합으로 실행한 빌드가 문서를 게시하며 커밋의 Checks에서 상태를 확인합니다.

master에 커밋한 것만으로 게시되는 것은 아닙니다. 빌드가 필요하며 저장소가 게시 허용 목록에 있어야 합니다.

반영 시점

이미 게시한 페이지의 내용 변경은 게시 후 즉시 보입니다. 새 페이지와 전체 탐색 구조 변경은 문서 서비스가 상태를 다시 컴파일한 뒤 나타납니다. 기본 재컴파일 주기는 한 시간이며 관리자가 조정할 수 있습니다.

삭제한 페이지는 재게시가 반영되면 본문에서 사라지지만 홈의 번들 항목과 목차는 재컴파일까지 남아 있을 수 있습니다. 본문 제거와 탐색 목록 갱신을 구분합니다.

문서 제거

문서 저장소 자체를 삭제해도 게시한 문서가 자동으로 제거되지 않습니다. 없앨 페이지 파일을 저장소에서 제거한 뒤 master를 다시 빌드해 게시 결과에서 제외해야 합니다.

저장소 전체를 없애려면 먼저 docs 폴더의 모든 내용을 제거하고 재게시합니다. 게시 취소를 마친 뒤 저장소를 삭제해야 합니다. 이 순서를 바꾸면 게시 콘텐츠가 남을 수 있습니다.

독자 접근은 게시 결과를 만든 저장소의 View 권한에 따라 관리합니다. 목차와 페이지 선언은 번들 구조를 참조합니다.