複数のページでコンテンツを再利用する

このガイドでは、DevSite の記事間でコンテンツを共有する方法について説明します。

複数のページでコンテンツを再利用するには、変数とインクルードを使用します。これは、Composer の複数の記事でスニペットを使用する DevSite 版です。

注: support.google.com のヘルプセンターで共有コンテンツをクロスパブリッシュすることはできません。ナビゲーションでは任意のドメインのページにリンクできますが、DevSite 以外のドメインで記事やセクションを単一ソース化することはできません。

インクルードと変数を使用するタイミング

  • 短い単一ソースのテキスト文字列を再利用する場合は、変数を使用します。たとえば、プロダクト名や機能名などです。

  • 単一ソースの書式設定されたテキストまたは HTML を再利用する場合は、include を使用します。たとえば、機能の比較表や重要な注意事項などです。

変数を作成する

  1. google3/third_party/devsite/workspace/en/_globalvars.html を開きます。
    1. 右上の [Edit in Cider]（Cider で編集）をクリックします。

  2. 新しい変数定義を追加します。

    {% setvar YOUR_VARIABLE_NAME %}TEXT_TO_DISPLAY{% endsetvar %}
    • YOUR_VARIABLE_NAME は、使用する変数に置き換えます。
    • TEXT_TO_DISPLAY は、ユーザーに表示するテキストに置き換えます。

  3. 変更を保存し、審査と承認のために workspace-content-configs に CL を送信します。

  4. CL を送信したら、新しい変数名を使用してコンテンツを公開できます。

コンテンツに変数を入れる

ページに変数を使用するには、Jinja 変数を使用します。このシンプルな {{ ... }} 構造では、指定した変数のコンテンツがページのタグの位置に挿入されます。

例


**Note:** You can buy {{ workspace_name }} from a reseller.

<table>
  <tr>
    <th>Edition</th>
    <th>Cost</th>
  </tr>
  <tr>
    <td>{{ business_plus_sku_name }}</td>
    <td>$50 / month</td>
  </tr>
  <tr>
    <td>{{ business_standard_sku_name }}</td>
    <td>$20 / month</td>
  </tr>
  <tr>
    <td>{{ business_starter_sku_name }}</td>
    <td>No additional cost</td>
  </tr>
</table>

レンダリング

注: Google Workspace は販売パートナーから購入できます。

Edition 費用
Business Plus 月額 $50
Business Standard 月額 $20
Business Starter 追加料金なし

インクルード ファイルを作成する

重要: インクルード ファイルは常に HTML 形式である必要があります。これは、HTML 形式は HTML とマークダウンの両方のコードブロック コンテキストで機能しますが、マークダウン インクルードはマークダウン コードブロック コンテキストでのみ機能するためです。

チュートリアル動画を見る

インクルード ファイルを作成する手順は次のとおりです。

  1. Cider を開きます。

  2. コード検索またはファイル エクスプローラを使用して、third_party/devsite/workspace/en/_shared/includes/ フォルダを見つけます。

  3. includes フォルダを右クリックし、[New File]（スクリーンショット）をクリックします。

    • インクルードがコンテンツ セットにのみ関連する場合は、/includes フォルダ内にコンテンツ セットのサブフォルダを作成し、そこにインクルード ファイルを追加できます。例: …/workspace/en/shared/includes/cloud-search/_my-niche-snippet.html

  4. ファイルに名前を付けて、コンテンツを追加します。次のガイドラインに沿って対応してください。

    • ファイル名の先頭をアンダースコアにする。例: _my-new-include.htmlこれにより、インクルード ファイルが外部で独自のページになるのを防ぎます。
    • ファイル名には説明的な名前を付ける。これにより、誰もがインクルードを見つけて使用しやすくなります。
    • すべてのインクルードは HTML ファイルである必要があります。ファイル拡張子は .html でなければならず、ファイルに Markdown で記述された要素を含めることはできません。これにより、コンテンツがマークダウン ファイル、HTML ファイル、またはマークダウン ファイル内の HTML 要素に含まれている場合でも、コンテンツが正しくレンダリングされます。
    • コンテンツを多用途にする。インクルードの目的は、複数のページに収まるようにすることです。そのため、コンテンツはできるだけ再利用できるようにする必要があります。* 含めることが望ましいコンテンツ: 制限、注意点、仕組みなど、実装の詳細を含む手順と関連するメモやヒント。* 避ける: 見出しや概要（ビジネス ユースケースに合わせて、こちらで書式設定と作成を行います）。

例: 次に、Google Cloud プロジェクトのプロジェクト番号をコピーする手順のインクルード ファイルの例を示します。

third_party/devsite/workspace/en/_shared/includes/_copy-cloud-project-number-steps.html

詳細については、DevSite Publishing のドキュメントのファイルを追加するをご覧ください。

コンテンツにインクルードを追加する

ページにインクルードを追加するには、include タグを使用します。include タグは、指定したファイルの内容をページのタグの位置に挿入します。

前のセクションのサンプル ファイルのインクルード タグの例を次に示します。

例


{% include "_shared/includes/_copy-cloud-project-number-steps.html" %}

レンダリング

  1. Google Cloud コンソールで、メニュー アイコン 次に [IAM と管理] 次に [設定] に移動します。

    [IAM と管理] の [設定] に移動

  2. [プロジェクト番号] フィールドで、値をコピーします。

移行されたスニペット ファイル

Composer のスニペットが third_party/devsite/workspace/en/_shared/snippets フォルダに移行されました。コンテンツが DevSite に移行される前に Composer でスニペットを使用していた場合、コンテンツには次の例のような include タグが表示されます。

{% include "_shared/snippets/_snippet-9393389.html" %}

新しいインクルード ファイルを _shared/snippets フォルダに追加しないでください。

クロス パブリッシング

DevSite では、各ページは 1 つのコンテンツ セットに属します。Devsite では、Composer で使用されるクロス パブリッシング（1 つのページを複数のヘルプセンターに公開できる）はサポートされていません。代わりに、目次（TOC）内から他のコンテンツ セットのページにリンクできます。

別のコンテンツ セットのページをナビゲーションに追加する

ナビゲーションで別のコンテンツ セットのページにリンクする手順は次のとおりです。

  1. コンテンツ セットの _book.yaml ファイルを開きます。_book.yaml ファイルは、サイトのナビゲーションを管理する場所です。
  2. リンク先のページのタイトルとルートパスを追加します。

次の例では、Cloud Search の _book.yaml ファイルが、事業継続コンテンツ セットの記事にリンクしています。

    - name: "Guides"
      contents:
      - heading: "Getting started"
      - title: "What is Google Cloud Search?"
        path: /cloud-search/what-is-google-cloud-search 
      - title: "Deploy 2-Step Verification"
        path: /business-continuity/security-and-monitoring/deploy-2-step-verification

ユーザーが Cloud Search のナビゲーションで [2 段階認証プロセスを導入する] リンクをクリックすると、事業継続に関するドキュメントのページが表示されます。

サイトのナビゲーションの更新について詳しくは、ナビゲーションを更新するをご覧ください。