로컬 환경에서 텍스트 편집기를 사용하여 소스 설명서 페이지를 만듭니다

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

주제:

작성 대상:

개발자

이 문서는 로컬 환경을 사용하여 소스에 대한 설명서를 작성하고 가져오기 요청(PR)을 제출하는 방법에 대한 단계를 제공합니다.

TIP

Adobe 기여 안내서의 다음 문서를 사용하여 설명서 프로세스를 추가로 지원할 수 있습니다.

전제 조건

다음 자습서를 사용하려면 로컬 컴퓨터에 GitHub Desktop이 설치되어 있어야 합니다. GitHub Desktop이 없는 경우 응용 프로그램을 여기에서 다운로드할 수 있습니다.

GitHub에 연결하고 로컬 작성 환경 설정

로컬 작성 환경을 설정하는 첫 번째 단계는 Adobe Experience Platform GitHub 저장소로 이동하는 것입니다.

platform-repo

Platform GitHub 리포지토리의 기본 페이지에서 포크 를 선택합니다.

로컬 컴퓨터에 리포지토리를 복제하려면 코드 을(를) 선택하십시오. 표시되는 드롭다운 메뉴에서 HTTPS 을(를) 선택한 다음 GitHub Desktop으로 열기 를 선택합니다.

TIP

자세한 내용은 로컬에서 설명서를 위한 Git 리포지토리 설정에 대한 자습서를 참조하십시오.

git-desktop 열기

그런 다음 GitHub Desktop이 experience-platform.en 리포지토리를 복제할 수 있도록 잠시 기다려 주십시오.

복제 프로세스가 완료되면 GitHub Desktop으로 이동하여 새 분기를 만듭니다. 위쪽 탐색에서 기본 을 선택한 다음 새 분기 를 선택합니다.

새 분기

표시되는 팝오버 패널에서 분기의 수사적 이름을 입력한 다음 분기 만들기 를 선택합니다.

create-branch-vs

그런 다음 Publish 분기 를 선택합니다.

publish-branch

소스에 대한 설명서 페이지 작성

로컬 컴퓨터에 복제된 저장소와 새 분기가 생성되면 이제 선택한 텍스트 편집기를 통해 새 소스에 대한 설명서 페이지 작성을 시작할 수 있습니다.

Adobe은 Visual Studio Code을 사용하고 Adobe Markdown 작성 확장을 설치하는 것을 권장합니다. 확장을 설치하려면 Visual Studio Code를 시작한 다음 왼쪽 탐색에서 확장 탭을 선택합니다.

검색 창에 Adobe Markdown Authoring을(를) 입력한 다음 나타나는 페이지에서 설치 를 선택합니다.

로컬 컴퓨터가 준비된 상태에서 소스 설명서 템플릿을(를) 다운로드하고 선택한 범주를 나타내는 [...]을(를) 사용하여 experience-platform.en/help/sources/tutorials/api/create/...에 파일을 추출합니다. 예를 들어 데이터베이스 소스를 만드는 경우 데이터베이스 폴더를 선택합니다.

마지막으로 템플릿에 요약된 지침에 따라 소스와 관련된 관련 정보로 템플릿을 편집합니다.

edit-template

검토를 위해 설명서 제출

끌어오기 요청(PR)을 만들고 검토할 문서를 제출하려면 먼저 Visual Studio Code (또는 선택한 텍스트 편집기)에 작업을 저장하십시오. 그런 다음 GitHub Desktop을 사용하여 커밋 메시지를 입력하고 Commit to create-source-documentation 을(를) 선택합니다.

커밋 대