Experience Manager GuidesとEdge Delivery Services(Beta)
Adobe Experience Manager Guidesを使用すると、専用の GitHub ベースの公開プロファイルを通じて、DITA コンテンツをEdge Delivery Services(EDS)(現在 Beta で利用可能)に直接公開できます。 この機能を使用すると、Experience Manager Guidesで DITA ベースのオーサリングワークフローを維持しながら、高パフォーマンスでレスポンシブなドキュメントエクスペリエンスを提供できます。
Adobe Experience Managerでの EDS の使用について詳しくは、Edge Delivery Servicesの概要 を参照してください。
Experience Manager Guidesから EDS (Beta)に公開できるようにするには、GitHub とExperience Manager Guidesをまたいで一連の設定手順を実行する必要があります。 以下の節では、各手順を順番に説明し、公開ワークフロー全体で各手順がどのように連携するかについて説明します。
ビデオの簡単なチュートリアルについては、AEM Guidesでの公開 を参照してください。
GitHub for EDS のセットアップと設定(Beta)
この節では、EDS (Beta)で使用する GitHub のセットアップ方法と設定方法について説明します。 Adobe ボイラープレートを使用したリポジトリーの作成、AEM コード同期を通じたAdobe Experience Managerへの GitHub の接続、必要な GitHub および OAuth アプリケーションの設定、コンテンツの公開に使用するリポジトリーマウントポイントの定義について説明します。
EDS 用の GitHub リポジトリの作成(Beta)
EDS (Beta)には、事前に定義された構造を持つ GitHub リポジトリが必要です。 Adobeは、Experience Manager Guides ユーザー向けに特別に設計された、公式のボイラープレートリポジトリを提供します。
リポジトリを作成するには、次の手順を実行します。
-
Experience Manager Guides ボイラープレートテンプレートリポジトリ
aem-guides-boilerplateージを開きます。
-
このテンプレートを使用して新しいリポジトリを作成します。 テンプレートからのリポジトリの作成 について説明します。 EDS からアクセスできるように、リポジトリの表示が 公開 に設定されていることを確認します。
これで、リポジトリが作成され、ボイラープレートテンプレート構造に合わせて配置されます。
AEM Code Sync を使用して GitHub をAdobeに接続する
Adobe Experience Managerは、AEM コード同期 と呼ばれる GitHub アプリケーションを使用して、コンテンツをExperience Manager Guidesから GitHub にプッシュします。
次の手順を実行して、AEM Code Sync アプリケーションをインストールし設定します。
-
AEM コード同期 ページに移動して、「インストール」を選択します。
-
AEM コード同期 は、リポジトリの変更を監視し、更新が GitHub に正しくプッシュされていることを確認します。
note note NOTE アプリケーションのインストール時に、リポジトリを所有しているのと同じ GitHub アカウントを使用していることを確認してください。
-
次のページで、作成したリポジトリへのアクセス権を付与します。 これを行うには、「リポジトリの選択のみ」オプションを選択し、ドロップダウンからリポジトリを選択します。
{width="350"}
-
インストールして認証 を選択します。
GitHub のセットアップページにリダイレクトされ、AEM Code Sync アプリケーションの登録が成功したことが確認されます。 このページから、web サイトのプレビュー URL とライブ URL を保存することもできます。
新しい GitHub アプリの作成
-
GitHub で、左側のサイドバーに移動し、「開発者設定」を選択します。
-
左側のサイドバーで、「GitHub アプリ」を選択します。
-
「新規 GitHub アプリ」を選択します。
{width="650"}
-
新しい GitHub アプリを登録 ページで、次の詳細を入力します。
-
GitHub アプリ名:アプリの名前を入力します。 例えば、
USERNAME-eds-appの場合、USERNAME は GitHub のユーザー名です。 -
ホームページ URL:Experience Manager Guides インスタンスへの URL を入力します。
サンプル URL (形式):
https://<aem-author-url>/libs/fmdita/clientlibs/xmleditor/page.htmlサンプル URL:
https://author-p16602-e335172-cmstg.adobeaemcloud.com/libs/fmdita/clientlibs/xmleditor/page.html -
コールバック URL:ホームページ URL と同じです。
-
Webhook URL:このオプションを無効にします。
-
リポジトリ権限:アクション、管理、アテステーション の 読み取りおよび書き込み 権限を設定します。
-
-
「GitHub アプリを作成」を選択します。
これで、アプリの準備が整いました。 GitHub アプリの 設定 ページにリダイレクトされます。
新しい OAuth アプリの作成
Experience Manager Guidesで EDS (Beta)公開プロファイルを作成する際にユーザーを認証するには、OAuth アプリが必要です。 クライアント ID および クライアントシークレット を使用した安全なログインフローを有効にします。
以下の手順を実行して、新しい OAuth アプリを作成します。
-
GitHub で、左側のサイドバーに移動し、「開発者設定」を選択します。
-
左側のサイドバーで、「OAuth アプリ」を選択します。
-
「新規 OAuth アプリ」を選択します。
{width="650"}
-
次の必須詳細を入力して、アプリケーションを登録します。
- アプリケーション名:EDS リポジトリの名前を入力します
- ホームページ URL:Experience Manager Guides インスタンスへの URL を入力します。 (サンプル URL 形式については、「 新しい GitHub アプリの作成 」のステップ 4 を参照してください。
- 認証コールバック URL:ホームページ URL と同じ
-
「デバイスフローを有効にする」オプションを選択し、「アプリケーションを登録」を選択して登録を完了します。
{width="650"}
これで、アプリの準備が整いました。 クライアント ID をメモしておきます。 Experience Manager Guidesで公開プロファイルを設定する際に、今または後で最大 5 つの クライアントシークレット を生成できます。
EDS (Beta)リポジトリ内のマウントポイント URL の構成
EDS (Beta)は、ファイル内の マウントポイント fstab.yaml URL として定義された GitHub リポジトリーパスからコンテンツを読み取ります。
fstab.yaml ファイルのマウントポイント URL を構成するには、次の手順に従います。
-
リポジトリで
fstab.yamlファイルを開き、以下を更新します。your-user-nameyour-repo-name
note note NOTE マウントポイント URL で、 mainはコンテンツを公開するブランチを示し、docsは作業中の EDS (Beta)リポジトリのルートフォルダーを示します。 GitHub のブランチ名を変更する場合は、(ファイル内の mountpointfstab.yamlURL と、対応するExperience Manager Guidesの EDS 公開プロファイルに記載された同じブランチ名を更新する必要があります。 {width="650"}
-
「変更をコミット」を選択し、コミットの詳細を入力して確認します。
-
開発者設定 に戻り、アプリを探して 編集 を選択します。
{width="650"}
-
「アプリをインストール」ページに移動し、「インストール」を選択します。
{width="650"}
-
AEM コード同期を使用して GitHub をAdobeに接続する セクションの手順 2 と 3 を繰り返して、リポジトリを認証します。
Experience Managerでの EDS (Beta)用の公開プロファイルの作成と設定
以下の節では、各手順を順に説明し、EDS (Beta)公開プロファイルを設定する方法、出力プリセットを設定する方法、Experience Manager Guidesで EDS (Beta)を使用して出力を生成する方法について説明します。
EDS (Beta)公開プロファイルの作成
-
Workspace設定 > プロファイルを公開 に移動します。
-
+ アイコンを選択して新しい公開プロファイルを作成し、次の詳細を入力します。
- サーバータイプ:ドロップダウンから GitHub Edge Delivery Services (Beta) を選択します。
- 名前:このプロファイルの名前を入力します。
- リポジトリ名:ボイラープレートから作成した GitHub リポジトリ名を使用します。
- ユーザー名:GitHub のユーザー名を入力します。
- Branch main:main (デフォルト)に設定します。
- ルートフォルダー:docs に設定します(デフォルト)。
- クライアント ID とクライアントシークレット:GitHub アプリからこれらを取得します(詳しくは、 新しい OAuth アプリの作成 の節を参照してください)。
-
「ログイン」を選択して認証します。
{width="650"}
-
認証に成功したら、「保存」を選択します。
これで、EDS (Beta)公開プロファイルが設定されました。
EDS (Beta)の出力プリセットを作成して、出力を生成する
-
マップ コンソールでマップを開きます。
-
「出力プリセット」タブで、「+」を選択して新しい出力プリセットを作成します。
-
新しい出力プリセット ダイアログで、次の詳細を入力します。
- 種類: Edge Delivery サービス (Beta)を選択してください
- 名前:このプリセットの名前を指定します
-
「追加」を選択します。
{width="650"}
-
新しく作成した EDS (Beta)出力プリセットを開き、「Config」タブに移動します。
- 前の手順で作成したパブリッシュプロファイルを選択します。
- プッシュをライブに を有効にします。
ライブにプッシュ が有効な場合、生成された出力は GitHub にコミットされ、対応する更新がライブ web サイトに直ちに反映されます。
{width="650"}
-
保存 を選択し、次に 出力を生成 を選択します。
これで、EDS (Beta)出力が生成されました。 コンテンツは、クリーンでレスポンシブなレイアウトで表示されます。 ページタイトル、パンくずリスト、本文コンテンツ、トピックで使用されるブロックなどの通常の要素が含まれます。 左側の目次(マップから生成)はトピック間を移動するのに役立ち、右側のミニ目次は現在のページ内のセクションをハイライト表示します。 出力全体が完全にレスポンシブなため、デバイス間で最適化された一貫性のある読み取りエクスペリエンスが確保されます。
EDS ブロックを使用した出力のカスタマイズ
EDS は、blocks を使用して、コンテンツのさまざまな部分のスタイル設定および表示方法を制御します。 既存のブロックを修正したり、カスタムのブロックを作成することができます。
以下に概説する例では、既存のブロックをカスタマイズし、新しいブロックを作成して、Experience Manager Guidesの最終的な EDS (Beta)出力のスタイルを設定する方法について順を追って説明します。
パンくずブロックをカスタマイズしてテキストの色を更新
パンくずリストは、ユーザーがドキュメント内の位置を理解するのに役立つように、ページ全体で使用されます。 このブロックは web サイト全体で一貫して表示されるので、スタイル設定を更新すると、統一されたデザイン更新が可能になります。
パンくずブロックをカスタマイズしてテキストの色を更新するには、次の手順を実行します。
-
GitHub リポジトリに移動し、
blocksフォルダーを開きます。 -
パンくず ブロックを選択します。
{width="650"}
-
cssファイルを開き、テキストの色を更新します。 -
変更内容を GitHub にコミットします。
-
ライブ web サイトを更新して、更新内容を表示します。
EDS (Beta)スクリプトを更新して、公開出力にカスタム要素を作成する
場合によっては、コンテンツの特定の部分のみのスタイルを設定したい場合があります。 カスタムブロックを使用してこれを行うには、次の手順を実行します。
-
トピックファイルを開き、タグ要素内のテキストを選択します。
次のスクリーンショットでは、
exampleタグ内のコンテンツが選択されています。
{width="650"}
-
exampleタグ内のテキストを設定するには:- コンテンツのプロパティ に移動します。
outputclass属性を追加します。- その値を
example eds-force-blockに設定します。 - 「追加」を選択します。
{width="650"}
-
出力を保存して再生成します。
-
outputclassディレクトリ内に、blocksと同じ名前の新しいフォルダーを作成します。 リポジトリへのファイルの追加 について説明します。 {width="650"}
-
必須の
cssファイルとオプションのjsファイルを追加します。 {width="650"}
-
変更をコミットして出力を再生成します。
選択したコンテンツには、ブロックで定義したカスタムスタイル設定が表示されます。