GitHub 웹 인터페이스를 사용하여 소스 설명서 페이지 만들기

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

주제:

작성 대상:

개발자

이 문서에서는 GitHub 웹 인터페이스를 사용하여 설명서를 작성하고 가져오기 요청(PR)을 제출하는 방법에 대한 단계를 제공합니다.

TIP

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

GitHub 환경 설정

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

platform-repo

그런 다음 포크 를 선택합니다.

포크가 완료되면 마스터 를 선택하고 표시되는 드롭다운 메뉴에 새 분기 이름을 입력하십시오. 분기를 설명하는 이름을 지정하십시오. 이 이름은 작업을 포함하는 데 사용됩니다. 그런 다음 분기 만들기 를 선택하십시오.

create-branch

포크된 리포지토리의 GitHub 폴더 구조에서 experience-platform.en/help/sources/tutorials/api/create/(으)로 이동한 다음 목록에서 소스에 대한 적절한 범주를 선택합니다. 예를 들어 새 CRM 원본에 대한 설명서를 만드는 경우 crm 을 선택하십시오.

TIP

UI에 대한 설명서를 만드는 경우 experience-platform.en/help/sources/tutorials/ui/create/(으)로 이동하여 소스에 적합한 범주를 선택합니다. 이미지를 추가하려면 experience-platform.en/help/sources/images/tutorials/create/sdk(으)로 이동한 다음 스크린샷을 sdk 폴더에 추가합니다.

crm

기존 CRM 소스의 폴더가 표시됩니다. 새 소스에 대한 설명서를 추가하려면 파일 추가 를 선택한 다음 표시되는 드롭다운 메뉴에서 새 파일 만들기 를 선택하십시오.

create-new-file

소스 파일 이름을 YOURSOURCE.md로 지정합니다. 여기서 YOURSOURCE는 Platform의 소스 이름입니다. 예를 들어 회사가 ACME CRM인 경우 파일 이름은 acme-crm.md이어야 합니다.

git-interface

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

새 소스에 대한 설명서를 시작하려면 소스 설명서 템플릿의 내용을 GitHub 웹 편집기에 붙여 넣으십시오. 여기에서 템플릿을 다운로드할 수도 있습니다.

GitHub 웹 편집기 인터페이스에 복사된 템플릿을 사용하여 템플릿에 설명된 지침에 따라 소스에 대한 관련 정보가 포함된 값을 편집합니다.

템플릿 붙여넣기

완료되면 분기에서 파일을 커밋합니다.

검토를 위해 설명서 제출

파일이 커밋되면 가져오기 요청(PR)을 열어 작업 분기를 Adobe 문서 저장소의 마스터 분기로 병합할 수 있습니다. 작업 중인 분기가 선택되었는지 확인한 다음 비교 및 가져오기 요청 을 선택하십시오.

compare-pr

기준 및 비교 분기가 올바른지 확인합니다. PR에 업데이트를 설명하는 메모를 추가한 다음 끌어오기 요청 만들기 를 선택합니다. 그러면 작업의 작업 분기를 Adobe 저장소의 마스터 분기로 병합하는 PR이 열립니다.

TIP

Adobe 설명서 팀이 PR을 편집할 수 있도록 유지 관리자가 편집 허용 확인란을 선택한 상태로 두십시오.

create-pr

이때 Adobe 기여자 라이선스 계약(CLA)에 서명하라는 메시지가 표시됩니다. 필수 단계입니다. CLA에 서명한 후 PR 페이지를 새로 고치고 끌어오기 요청을 제출합니다.

https://github.com/AdobeDocs/experience-platform.en에서 가져오기 요청 탭을 검사하여 가져오기 요청이 제출되었는지 확인할 수 있습니다.

confirm-pr

recommendation-more-help

337b99bb-92fb-42ae-b6b7-c7042161d089