ローカル環境でのテキストエディターを使用したソースドキュメントページの作成

このドキュメントでは、ローカル環境を使用して、ソースに関するドキュメントを作成し、プル要求 (PR) を送信する手順を説明します。

前提条件

以下のチュートリアルでは、GitHub Desktop をローカルマシンにインストールしておく必要があります。 GitHub Desktop をお持ちでない場合は、アプリケーションをダウンロードできます ここ.

GitHub に接続し、ローカルのオーサリング環境を設定する

ローカルオーサリング環境を設定する最初の手順は、 Adobe Experience Platform GitHub リポジトリ.

Platform GitHub リポジトリのメインページで、 分岐.

リポジトリをローカルマシンに複製するには、 コード. 表示されるドロップダウンメニューから、「 」を選択します。 HTTPS 次に、「 GitHub Desktop で開く.

次に、GitHub Desktop が experience-platform.en リポジトリ。

クローン作成プロセスが完了したら、GitHub Desktop にアクセスし、新しいブランチを作成します。 選択 マスター 上部ナビゲーションから、「 」を選択します。 新しいブランチ

表示されるポップオーバーパネルで、ブランチのわかりやすい名前を入力し、「 」を選択します。 ブランチを作成.

次に、「 ブランチを公開.

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

リポジトリをローカルマシンに複製し、新しいブランチを作成したら、次を使用して、新しいソースのドキュメントページのオーサリングを開始できます。 任意のテキストエディター.

Adobeでは、 Visual Studio Code Markdown Authoring 拡張機能をインストールするAdobe。 拡張機能をインストールするには、Visual Studio Code を起動し、 拡張機能 タブをクリックします。

次に、 Adobe Markdown Authoring を検索バーに追加し、「 インストール 表示されるページから。

ローカルマシンの準備が整ったら、 ソースドキュメントテンプレート を選択し、次の場所にファイルを抽出します。 experience-platform.en/help/sources/tutorials/api/create/... 次を使用 [...] 選択したカテゴリを表します。 例えば、データベースソースを作成する場合は、データベースフォルダを選択します。

最後に、テンプレートに記載されている手順に従い、ソースに関する関連情報を使用してテンプレートを編集します。

ドキュメントを送信してレビューします

プル要求 (PR) を作成し、レビュー用にドキュメントを送信するには、まず Visual Studio Code （または任意のテキストエディター）。 次に、GitHub Desktop を使用して、コミットメッセージを入力し、「 」を選択します。 create-source-documentation にコミット.

次に、「 プッシュ元 をクリックして、作業をリモートブランチにアップロードします。

プル要求を作成するには、「 プル要求の作成.

ベースと比較ブランチが正しいことを確認します。 PR にメモを追加し、更新内容を説明してから、「 」を選択します。 プル要求の作成. PR を開き、作業の作業ブランチをAdobeリポジトリの master ブランチにマージします。

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