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

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

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

前提条件

次のチュートリアルでは、ローカルマシンに GitHub Desktop をインストールする必要があります。 GitHub デスクトップがない場合は、アプリケーションを こちらからダウンロードできます。

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

ローカルオーサリング環境を設定する最初の手順は、Adobe Experience Platform GitHub リポジトリに移動することです。

platform-repo

Platform GitHub リポジトリのメインページで、「分岐」を選択します。

分岐

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

TIP
詳しくは、 ドキュメント用の Git リポジトリのローカルでのセットアップに関するチュートリアルを参照してください。

open-git-desktop

次に、GitHub デスクトップで experience-platform.en リポジトリのクローンが作成されるまでしばらく待ちます。

複製

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

new-branch

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

create-branch-vs

次に、「Publishブランチ」を選択します。

publish-branch

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

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

Adobeでは、Visual Studio Code を使用し、Adobeの Markdown オーサリング拡張機能をインストールすることをお勧めします。 拡張機能をインストールするには、Visual Studio Code を起動し、左側のナビゲーションから「拡張機能」タブを選択します。

拡張機能

次に、検索バーに Adobe Markdown Authoring と入力し、表示されるページから インストール を選択します。

インストール

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

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

edit-template

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

プルリクエスト(PR)を作成し、ドキュメントをレビュー用に送信するには、まず Visual Studio Code (または選択したテキストエディター)で作業内容を保存します。 次に、GitHub デスクトップを使用して、コミットメッセージを入力し、「Commit to create-source-documentation」を選択します。

commit-vs

次に、「接触チャネルをプッシュ」を選択して、作業をリモートブランチにアップロードします。

プッシュオリジン

プルリクエストを作成するには、「プルリクエストを作成」を選択します。

create-pr-vs

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

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

create-pr

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

confirm-pr

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089