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

最終更新日： 2025年5月5日

トピック：

作成対象：

開発者

このドキュメントでは、GitHub web インターフェイスを使用して、ドキュメントを作成し、プルリクエスト（PR）を送信する手順を説明します。

ヒント

ドキュメントプロセスをさらにサポートするには、Adobeのコントリビューションガイドに記載されている次のドキュメントを使用できます。

GitHub 環境の設定

GitHub 環境を設定する最初の手順は、Adobe Experience Platform GitHub リポジトリに移動することです。

platform-repo

次に、「分岐」を選択します。

分岐が完了したら、「マスター」を選択し、表示されるドロップダウンメニューに新しいブランチの名前を入力します。ブランチの名前は作業を格納するために使用されるため、わかりやすい名前を指定し、「ブランチを作成」を選択します。

create-branch

フォークしたリポジトリーの 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 は、Experience Platformでのソースの名前です。例えば、会社が ACME CRM の場合、ファイル名は acme-crm.md にします。

git インターフェイス

ソースのドキュメントページを作成する

新しいソースのドキュメント化を開始するには、sources documentation template のコンテンツを GitHub web エディターに貼り付けます。テンプレートはこちらからダウンロードすることもできます。

テンプレートを GitHub web エディターインターフェイスにコピーしたら、テンプレートに記載されている手順に従って、ソースに関連する情報を含んだ値を編集します。

paste-template

完了したら、ブランチでファイルをコミットします。

コミット

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

ファイルがコミットされたら、プルリクエスト（PR）を開いて、作業中のブランチをAdobe ドキュメントリポジトリのマスターブランチに結合できます。作業中のブランチが選択されていることを確認し、「比較してプル要求」を選択します。

compare-pr

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

ヒント

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

create-pr

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

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

confirm-pr