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

이 페이지의 지침은 로컬 환경에서 텍스트 편집기를 사용하여 설명서를 작성하고 가져오기 요청(PR)을 제출하는 방법을 보여줍니다. 여기에 표시된 단계를 거치기 전에 다음을 읽어야 합니다 Adobe Experience Platform 대상에서 대상 문서화.

GitHub에 연결하고 로컬 작성 환경 설정 set-up-environment

  1. 브라우저에서 다음 위치로 이동합니다 https://github.com/AdobeDocs/experience-platform.en

  2. 종료 포크 저장소에서 포크 아래와 같이 표시됩니다. 이렇게 하면 고유한 GitHub 계정에 Experience Platform 리포지토리의 사본이 만들어집니다.

    포크 Adobe 문서 리포지토리

  3. 로컬 컴퓨터에 리포지토리 복제. 선택 코드 > HTTPS > GitHub Desktop으로 열기 ​아래에 표시된 대로 를 클릭합니다. 다음을 수행했는지 확인하십시오. GitHub Desktop 설치됨. 자세한 내용은 다음을 참조하십시오. 저장소의 로컬 복제 만들기 Adobe 기여자 안내서에서 참조하십시오.

    로컬 환경에 Adobe 설명서 리포지토리 복제

  4. 로컬 파일 구조에서 다음으로 이동합니다. experience-platform.en/help/destinations/catalog/[...], 여기서 [...] 는 대상에 대해 원하는 범주입니다. 예를 들어 Experience Platform에 개인화 대상을 추가하는 경우 personalization 폴더를 삭제합니다.

대상의 설명서 페이지 작성 author-documentation

  1. 설명서 페이지는 셀프서비스 대상 템플릿. 다운로드 대상 템플릿. 압축 풀기 및 파일 추출 yourdestination-template.md 위의 4단계에서 언급된 디렉터리로 이동합니다. 파일 이름 바꾸기 YOURDESTINATION.md여기서 YOURDESTINATION은 Adobe Experience Platform의 대상 이름입니다. 예를 들어 회사의 이름이 Moviestar인 경우 파일 이름을 지정합니다 moviestar.md.
  2. 에서 새 파일 열기 선택한 텍스트 편집기. Adobe은 다음을 권장합니다. Visual Studio 코드 Adobe Markdown 작성 확장 프로그램을 설치합니다. 확장을 설치하려면 Visual Studio Code를 열고 Extensions 화면 왼쪽에 있는 를 탭하고 을 검색합니다. adobe markdown authoring. 확장을 선택하고 Install.
    Adobe Markdown 작성 확장 설치
  3. 대상에 대한 관련 정보로 템플릿을 편집합니다. 템플릿의 지침을 따릅니다.
  4. 설명서에 추가할 스크린샷이나 이미지에 대해서는 GitHub/experience-platform.en/help/destinations/assets/catalog/[...], 여기서 [...] 는 대상에 대해 원하는 범주입니다. 예를 들어 Experience Platform에 개인화 대상을 추가하는 경우 personalization 폴더를 삭제합니다. 대상에 대한 새 폴더를 만들고 여기에 이미지를 저장합니다. 작성 중인 페이지에서 해당 페이지에 연결해야 합니다. 다음을 참조하십시오 이미지에 연결하는 방법 지침.
  5. 준비가 되면 작업 중인 파일을 저장합니다.

검토를 위해 설명서 제출 submit-review

TIP
여기서 깰 수 있는 것은 아무것도 없습니다. 이 섹션의 지침에 따라 설명서 업데이트를 제안하면 됩니다. 제안된 업데이트는 Adobe Experience Platform 설명서 팀에서 승인하거나 편집합니다.
  1. GitHub Desktop에서 업데이트의 작업 분기를 만들고 분기 게시 : 분기를 GitHub에 게시합니다.

새 로컬 분기

  1. GitHub Desktop에서 커밋 아래 표시된 대로 작업을 수행합니다.

    커밋 로컬

  2. GitHub Desktop에서 푸시 에 대한 내 작업 원격 아래에 표시된 대로 분기합니다.

    커밋 푸시

  3. GitHub 웹 인터페이스에서 가져오기 요청(PR)을 열어 작업 분기를 Adobe 문서 저장소의 마스터 분기로 병합합니다. 작업한 분기가 선택되어 있는지 확인하고 선택합니다 Contribute > 가져오기 요청 열기.

    가져오기 요청 만들기

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

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

    Adobe 설명서 저장소에 대한 가져오기 요청 만들기

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

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

PR 성공

  1. 감사합니다. Adobe 설명서 팀은 편집이 필요한 경우 PR에 연락하여 설명서가 게시되는 시기를 알려 줍니다.
TIP
설명서에 이미지 및 링크를 추가하고 Markdown에 대한 기타 질문이 있는 경우 다음을 참조하십시오. Markdown 사용 Adobe의 공동 작업 쓰기 안내서에서 참조할 수 있습니다.
recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6