플랫폼 내부 사용자 정의 문서

사용자 정의 문서(Custom documentation)는 Documentation 유형의 Code Repository에서 작성하고 플랫폼 안에 게시하는 문서입니다. 조직의 앱과 업무 지침을 관리할 수 있으며 AIP Assist의 색인에 포함해 조직 문서를 바탕으로 질문에 답하도록 사용할 수도 있습니다.

앱 실행기에서 열거나, 작업 공간에 사용자 정의 문서가 있으면 왼쪽 도움말 아이콘에서 접근합니다. 직접 주소는 인스턴스의 /workspace/documentation/입니다. 공개 문서로 연결하는 /docs 설정과는 다른 경로입니다.

문서 앱에는 SAP 커넥터 설치 안내처럼 사용자 정의 저장소에서 오지 않은 기본 제공 문서가 함께 있을 수도 있습니다.

앱 이름

Control Panel의 Platform experience에서 정한 플랫폼 제목을 사용합니다. 예를 들어 제목이 ABC이면 ABC documentation으로 표시합니다. 제목이 없거나 Palantir이면 기본 이름은 Custom documentation입니다.

문서 저장소 생성

문서 저장 위치에서 New > Code repository를 선택합니다. Find and select repository type 검색 또는 Building something else? 흐름에서 Documentation 템플릿을 고르고 저장소 이름과 위치를 정합니다.

문서 저장소는 Compass 리소스이므로 저장 위치의 권한을 고려해야 합니다. 템플릿을 사용하는 것과 해당 위치에 저장소를 만들 권한은 구분합니다.

게시 허용 목록

게시할 저장소는 문서 서비스가 발견하고 사용할 수 있도록 허용 목록에 등록해야 합니다. Control Panel > Documentation > Custom documentation에서 Configure which code repositories can publish documentation 설정을 켜고 대상 저장소를 허용합니다. 게시 활성화에는 Enrollment administrator의 조치가 필요합니다.

새 저장소는 생성 직후 첫 커밋의 검사를 자동 실행합니다. 이때는 아직 허용 목록에 등록되지 않아 PERMISSION_DENIED로 실패합니다. 저장소를 만들기 전에는 허용 목록에 등록할 수 없으므로, 생성 후 등록을 마치고 검사를 다시 실행해 문서를 게시합니다.

열람과 작성 권한

저장소의 View 접근을 가진 사용자만 그 저장소가 게시한 문서를 볼 수 있습니다. 파일시스템의 저장 위치와 역할로 제한된 독자에게 먼저 공유하고 이후 대상을 넓힐 수 있습니다.

Documentation 템플릿은 일반 사용자에게도 제공되지만 템플릿 선택만으로 게시 권한이 생기지는 않습니다. 저장소 작성 권한과 관리자의 게시 허용을 모두 준비해야 합니다.

문서 구성과 운영

문서는 docs 폴더 안의 번들로 묶습니다. 번들과 페이지는 overview.md, ordering.md와 제목 및 목차 주석을 설명합니다. 일반 Markdown과 다른 제목 문법을 지켜야 합니다.

링크와 이미지는 번들 간 참조와 플랫폼 이미지 주소를, 안내 상자는 HTML 기반 메시지 서식을 다룹니다. 미리보기와 게시에서는 master 브랜치 빌드, 반영 시간과 안전한 게시 취소를 구분합니다.