소스 문서화
Adobe Experience Platform에서 새 소스를 라이브로 설정하기 전 마지막 단계는 새 소스를 문서화하는 것입니다.
이 설명서 안내서에는 다음이 포함됩니다.
- 새 소스에 대한 설명서 페이지를 만들기 위해 참조할 수 있는 튜토리얼
- 새 소스에 대해 작성할 설명서 템플릿
- 기술 설명서 작성을 위해 Markdown을 사용하는 방법에 대한 지침;
- Adobe Markdown 버전 이해 지침.
전제 조건
새 소스 문서화를 시작하려면 먼저 다음 항목이 필요합니다.
- 올바른 GitHub 사용자 계정: 기존 GitHub 계정이 없는 경우 GitHub 등록 페이지를 통해 계정을 만들어야 합니다.
- GitHub Desktop에 액세스: 로컬 환경에서 소스 설명서를 만들려면 GitHub Desktop 앱을 사용해야 합니다.
- Adobe과의 통합은 Platform의 스테이징 환경에 배포된 소스와 테스트 단계에 있어야 합니다.
Platform에서 소스에 대한 설명서를 만드는 고급 지침
상위 수준에서 소스에 대한 설명서를 만들려면 Platform 설명서 리포지토리의 포크를 만들고 제공된 설명서 템플릿을 새 분기에서 편집해야 합니다. Adobe이 제공한 템플릿을 사용하여 새 소스 페이지를 만들고 준비가 되면 가져오기 요청(PR)을 엽니다. 이 작업을 수행하는 지침은 새 소스 페이지를 만드는 단계의 아래에 자세히 나와 있습니다.
설명서 템플릿
미리 채워진 설명서 템플릿을 사용하여 소스에 대한 설명서를 만들 수 있습니다. 아래에서 템플릿을 편집하고 가져오기 요청을 여는 방법에 대한 지침을 확인할 수 있습니다. 새 소스에 대해 제출된 설명서는 Adobe 설명서 팀에서 검토하고 게시합니다.
아래의 설명서 템플릿을 다운로드할 수도 있습니다.
새 소스 페이지 만들기
GitHub 웹 인터페이스 또는 로컬 환경을 사용하여 Platform의 새 소스에 대한 설명서를 만들 수 있습니다. 아래 링크에서 두 옵션에 대한 지침을 확인하십시오.
recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089