ローカル環境でのテキストエディターを使用した宛先ドキュメントページの作成 local-authoring
このページの手順では、テキストエディターを使用してローカル環境で作業し、ドキュメントを作成してプルリクエスト(PR)を送信する方法を示します。 ここに示す手順を実行する前に、Adobe Experience Platformの宛先での宛先のドキュメント化を読んでください。
GitHub に接続し、ローカルオーサリング環境を設定します set-up-environment
-
ブラウザーで
https://github.com/AdobeDocs/experience-platform.en
に移動します。 -
リポジトリを 分岐するには、次に示すように、「分岐」をクリックします。 これにより、Experience Platformリポジトリのコピーが独自の GitHub アカウントに作成されます。
-
ローカルマシンにリポジトリのクローンを作成します。 次に示すように、「コード/HTTPS/GitHub デスクトップで開く」を選択します。 GitHub デスクトップがインストールされていることを確認します。 詳しくは、Adobeコントリビューターガイドの リポジトリのローカルクローンを作成するを参照してください。
-
ローカルファイル構造で、
experience-platform.en/help/destinations/catalog/[...]
に移動します。ここで、[...]
は宛先に必要なカテゴリです。 例えば、パーソナライゼーションの宛先をフォルダーに追加する場合は、personalization
Experience Platformーを選択します。
宛先に関するドキュメントページの作成 author-documentation
- ドキュメントページは、 セルフサービス宛先テンプレートに基づいています。 宛先テンプレートをダウンロードします。 それを解凍し、上記の手順 4 で説明したディレクトリに
yourdestination-template.md
ファイルを抽出します。 ファイル名をYOURDESTINATION.md
に変更します。YOURDESTINATION は、Adobe Experience Platformの宛先の名前です。 例えば、会社の名前が Moviestar の場合は、ファイルにmoviestar.md
という名前を付けます。 - 新しいファイルを任意の テキストエディターで開きます。 Adobeでは、Visual Studio Code を使用して、Adobeの Markdown オーサリング拡張機能をインストールすることをお勧めします。 拡張機能をインストールするには、Visual Studio Code を開き、画面の左側にある「Extensions」タブを選択して、
adobe markdown authoring
を検索します。 拡張機能を選択し、「Install」をクリックします。
- 宛先に関連する情報を使用してテンプレートを編集します。 テンプレートの指示に従います。
- ドキュメントに追加する予定のスクリーンショットまたは画像については、
GitHub/experience-platform.en/help/destinations/assets/catalog/[...]
に移動してください。[...]
れは、宛先に必要なカテゴリです。 例えば、パーソナライゼーションの宛先をフォルダーに追加する場合は、personalization
Experience Platformーを選択します。 宛先の新しいフォルダーを作成して、ここに画像を保存します。 オーサリングしているページからリンクする必要があります。 画像へのリンク方法を参照してください。 - 準備が整ったら、作業中のファイルを保存します。
レビュー用にドキュメントを送信 submit-review
- GitHub デスクトップで、更新用の作業ブランチを作成し、Publish ブランチ を選択して GitHub にブランチを公開します。
-
GitHub デスクトップで、以下に示すように、作業を コミットします。
-
GitHub デスクトップで、以下に示すように 🔗 作業を リモート ブランチにプッシュ」します。
-
GitHub web インターフェイスで、プルリクエスト(PR)を開いて、作業中のブランチをAdobeドキュメントリポジトリのマスターブランチに結合します。 作業したブランチが選択されていることを確認し、Contribute/プルリクエストを開く を選択します。
-
ベースおよび比較ブランチが正しいことを確認します。 更新を説明するメモを PR に追加し、「プルリクエストを作成」を選択します。 これにより、フォークの作業ブランチをAdobeリポジトリのマスターブランチに結合する PR が開きます。
note tip TIP Adobeドキュメントチームが PR を編集できるように、「メンテナーによる編集を許可」チェックボックスを選択したままにします。 -
この時点で、Adobe投稿者使用許諾契約(CLA)への署名を求める通知が表示されます。 これは必須の手順です。 CLA に署名したら、PR ページを更新し、プルリクエストを送信します。
-
https://github.com/AdobeDocs/experience-platform.en
の「プルリクエスト」タブを調べると、プルリクエストが送信されたことを確認できます。
- ご協力ありがとうございます。Adobeドキュメントチームが、編集が必要な場合は PR に連絡し、ドキュメントがいつ公開されるかを知らせます。