GitHub web インターフェイスを使用して、ソースドキュメントページを作成します

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

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

GitHub環境の設定

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

platform-repo

次に、Fork​を選択します。

​ フォーク ​

フォークが完了したら、main​を選択し、表示されるドロップダウンメニューに新しいブランチの名前を入力します。 作業を含めるために使用するブランチの記述的な名前を必ず指定し、ブランチを作成​を選択してください。

create-branch

フォークしたリポジトリのGitHub フォルダー構造で、experience-platform.en/help/sources/tutorials/api/create/に移動し、リストからソースに適したカテゴリを選択します。 例えば、新しいCRM ソースのドキュメントを作成する場合、crm​を選択します。

TIP
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-interface

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

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

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

貼り付けテンプレート ​

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

​ コミット ​

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

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

compare-pr

基本ブランチと比較ブランチが正しいことを確認します。 PRにメモを追加し、更新について説明してから、プルリクエストを作成​を選択します。 これにより、作業の作業ブランチをAdobe リポジトリのメインブランチに結合するためのPRが開きます。

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

create-pr

この時点で、Adobe コントリビューターライセンス契約(CLA)への署名を求める通知が表示されます。 これは必須のステップです。 CLAに署名したら、PR ページを更新してプルリクエストを送信します。

プルリクエストが送信されたことを確認するには、https://github.com/AdobeDocs/experience-platform.ja-JPの「プルリクエスト」タブを参照します。

confirm-pr

recommendation-more-help
experience-platform-help-sources