GitHub web インターフェイスを使用した宛先ドキュメントページの作成 github-interface

以下の手順は、GitHub web インターフェイスを使用して、ドキュメントを作成し、プルリクエスト(PR)を送信する方法を示しています。 ここに示す手順を実行する前に、Adobe Experience Platformの宛先での宛先のドキュメント化を読んでください。

GitHub オーサリング環境の設定 set-up-environment

  1. ブラウザーで https://github.com/AdobeDocs/experience-platform.en に移動します。

  2. リポジトリを 分岐するには、次に示すように、「分岐」をクリックします。 これにより、Experience Platformリポジトリのコピーが独自の GitHub アカウントに作成されます。

    分岐Adobeのドキュメントリポジトリ

  3. 次に示すように、リポジトリのフォークで、プロジェクトに新しいブランチを作成します。 この新しいブランチを作業に使用します。

    新しい GitHub ブランチの作成

  4. フォークされたリポジトリーの GitHub フォルダー構造で、experience-platform.en/help/destinations/catalog/[...] に移動します。ここで、[...] は宛先に必要なカテゴリです。 例えば、パーソナライゼーションの宛先をExperience Platformに追加する場合は、personalization カテゴリを選択します。 ファイルを追加/新しいファイルを作成 を選択します。

    新しいファイルを追加

  5. 宛先に YOURDESTINATION.md という名前を付けます。ここで、YOURDESTINATION はAdobe Experience Platformの宛先の名前です。 例えば、会社の名前が Moviestar の場合は、ファイルに moviestar.md という名前を付けます。

宛先に関するドキュメントページの作成 author-documentation

  1. ドキュメントのセルフサービステンプレートに基づいて、宛先ページのコンテンツを作成します。 テンプレートを ダウンロード し、展開して、.md ファイルテンプレートを抽出します。

  2. dillinger.io などのオンラインマークダウンエディターに、宛先に関連する情報とテンプレートのコンテンツを貼り付けて編集します。 入力すべき内容と削除可能な段落の詳細については、テンプレートの指示に従います。

    note tip
    TIP
    ブラウザーウィンドウはいつでも閉じ、後で再度開くことができます。 作業内容は自動的に保存され、ブラウザーを再び開くと待機されます。

    3. マークダウンエディターから GitHub の新しいファイルにコンテンツをコピーします。

  3. 使用する予定のスクリーンショットや画像について、GitHub インターフェイスを使用してファイルを experience-platform.en/help/destinations/assets/catalog/[...] にアップロードします。ここで、[...] は宛先に必要なカテゴリです。 例えば、パーソナライゼーションの宛先をExperience Platformに追加する場合は、personalization カテゴリを選択します。 オーサリングしているページから画像にリンクする必要があります。 画像へのリンク方法を参照してください。

    GitHub への画像のアップロード

  4. 準備ができたら、ブランチにファイルを保存します。

ファイルの作成を確認

レビュー用にドキュメントを送信 submit-review

TIP
ここで壊れるものはないことに注意してください。 この節の手順に従うことで、ドキュメントのアップデートを提案するだけです。 提案した更新は、Adobe Experience Platform ドキュメントチームによって承認または編集されます。
  1. ファイルを保存して目的の画像をアップロードしたら、プルリクエスト(PR)を開いて、作業ブランチをAdobeドキュメントリポジトリのマスターブランチに結合できます。 作業したブランチが選択されていることを確認し、Contribute/プルリクエストを開く を選択します。

プルリクエストの作成

  1. ベースおよび比較ブランチが正しいことを確認します。 更新を説明するメモを PR に追加し、「プルリクエストを作成」を選択します。 これにより、フォークの作業ブランチをAdobeリポジトリのマスターブランチに結合する PR が開きます。

    note tip
    TIP
    Adobeドキュメントチームが PR を編集できるように、「メンテナーによる編集を許可」チェックボックスを選択したままにします。

    Adobeドキュメントリポジトリへのプルリクエストの作成

  2. この時点で、Adobe投稿者使用許諾契約(CLA)への署名を求める通知が表示されます。 これは必須の手順です。 CLA に署名したら、PR ページを更新し、プルリクエストを送信します。

  3. https://github.com/AdobeDocs/experience-platform.en の「プルリクエスト」タブを調べると、プルリクエストが送信されたことを確認できます。

    PR 成功

  4. ご協力ありがとうございます。Adobeドキュメントチームが、編集が必要な場合は PR に連絡し、ドキュメントがいつ公開されるかを知らせます。

TIP
画像やドキュメントへのリンクを追加する方法、および Markdown に関するその他の質問については、Adobeの共同作業ライティングガイドの Markdown の使用を参照してください。
recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6