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

마지막 업데이트: 2023-11-01
  • 주제:
  • Sources
    이 항목에 대한 자세한 내용 보기
  • 작성 대상:
  • Developer
    User
    Admin
    Leader

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

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

GitHub 환경 설정

GitHub 환경을 설정하는 첫 번째 단계는 Adobe Experience Platform GitHub 저장소.

플랫폼 리포지토리

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

포크

포크가 완료되면 다음을 선택합니다. 마스터 드롭다운 메뉴에 새 분기 이름을 입력합니다. 분기가 작업을 포함하는 데 사용되므로 분기의 수사적 이름을 입력한 다음 을 선택합니다 분기 만들기.

분기 만들기

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

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-인터페이스

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

새 소스 문서화를 시작하려면 의 콘텐츠를 붙여 넣습니다. 소스 설명서 템플릿 를 GitHub 웹 편집기에 추가합니다. 템플릿을 다운로드할 수도 있습니다 여기.

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

템플릿 붙여넣기

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

커밋

검토를 위해 설명서 제출

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

compare-pr

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

나가기 유지 관리자의 편집 허용 Adobe 설명서 팀이 PR을 편집할 수 있도록 확인란을 선택했습니다.

create-pr

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

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

confirm-pr

이 페이지의