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

最終更新日： 2025年11月8日

トピック：
Sources

作成対象：

Developer

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

TIP

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

前提条件

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

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

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

platform-repo

Experience Platform GitHub リポジトリのメインページで、Forkを選択します。

フォーク

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

TIP

詳しくは、Git リポジトリをローカルに設定する方法に関するチュートリアルを参照してください。

open-git-desktop

次に、GitHub Desktopでexperience-platform.en リポジトリを複製する時間を少し設けます。

複製プロセスが完了したら、GitHub Desktopに移動して新しいブランチを作成します。上部のナビゲーションから マスター を選択し、新しいブランチを選択します

new-branch

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

create-branch-vs

次に、ブランチを公開を選択します。

publish-branch

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

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

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

拡張機能

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

インストール

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

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

edit-template

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

プルリクエスト（PR）を作成し、レビュー用にドキュメントを送信するには、まずVisual Studio Code （または選択したテキストエディター）に作品を保存します。次に、GitHub Desktopを使用して、コミットメッセージを入力し、Create-source-documentationへのコミットを選択します。

commit-vs