Menggunakan kembali konten di seluruh halaman

Panduan ini berisi informasi tentang cara membagikan konten di seluruh artikel di DevSite.

Untuk menggunakan kembali konten di beberapa halaman, Anda dapat menggunakan variabel dan include, yang merupakan versi DevSite dari penggunaan cuplikan di beberapa artikel di Composer.

Catatan: Publikasi silang konten bersama dengan Pusat Bantuan di support.google.com tidak dapat dilakukan. Anda dapat menautkan ke halaman dari domain mana pun di navigasi, tetapi Anda tidak dapat menggunakan satu sumber untuk artikel atau bagian dengan domain non-DevSite.

Waktu penggunaan include dan variabel

  • Gunakan variabel jika Anda ingin menggunakan kembali string teks singkat dari satu sumber. Misalnya, nama produk dan nama fitur.

  • Gunakan include jika Anda ingin menggunakan kembali teks atau HTML yang diformat dari satu sumber. Misalnya, tabel perbandingan fitur atau catatan penting.

Buat variabel

  1. Buka google3/third_party/devsite/workspace/en/_globalvars.html.
    1. Di kanan atas, klik Edit di Cider.

  2. Tambahkan definisi variabel baru.

    {% setvar YOUR_VARIABLE_NAME %}TEXT_TO_DISPLAY{% endsetvar %}
    • Ganti YOUR_VARIABLE_NAME dengan variabel yang ingin Anda gunakan.
    • Ganti TEXT_TO_DISPLAY dengan teks yang akan ditampilkan kepada pengguna.

  3. Simpan perubahan Anda dan kirim CL ke workspace-content-configs untuk ditinjau dan disetujui.

  4. Setelah CL dikirimkan, Anda dapat memublikasikan konten menggunakan nama variabel baru.

Menambahkan variabel ke konten Anda

Untuk menambahkan variabel ke halaman, gunakan variabel Jinja. Konstruksi {{ ... }} sederhana ini menyisipkan konten variabel yang ditentukan di lokasi tag pada halaman Anda.

Contoh


**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>

Hasil render

Catatan: Anda dapat membeli Google Workspace dari reseller.

Edisi Biaya
Business Plus $50 / bulan
Business Standard $20 / bulan
Business Starter Tanpa biaya tambahan

Membuat file include

Penting: File include harus selalu dalam format HTML. Hal ini karena format HTML dapat berfungsi dalam konteks blok kode HTML dan Markdown, tetapi include Markdown hanya berfungsi dalam konteks blok kode Markdown.

Tonton video tutorial

Untuk membuat file include, lakukan langkah-langkah berikut:

  1. Buka Cider.

  2. Gunakan Penelusuran Kode atau File Explorer untuk menemukan folder third_party/devsite/workspace/en/_shared/includes/.

  3. Klik kanan folder includes, lalu klik New File (screenshot).

    • Jika include hanya relevan dengan set konten, Anda dapat membuat subfolder untuk set konten dalam folder /includes dan menambahkan file include di sana. Sebagai contoh, …/workspace/en/shared/includes/cloud-search/_my-niche-snippet.html

  4. Beri nama file dan tambahkan konten Anda. Ikuti pedoman berikut:

    • Mulai nama file dengan garis bawah. Misalnya, _my-new-include.html. Hal ini mencegah file include menjadi halaman sendirinya secara eksternal.
    • Berikan deskripsi yang jelas pada nama file. Hal ini membuat include lebih mudah ditemukan dan digunakan oleh semua orang.
    • Semua include harus berupa file HTML. Ekstensi file harus .html dan file tidak boleh menyertakan elemen apa pun yang ditulis dalam Markdown. Hal ini memastikan bahwa konten akan dirender dengan benar, baik disertakan dalam file Markdown, file HTML, atau elemen HTML dalam file Markdown.
    • Buat konten yang serbaguna. Tujuan penyertaan adalah agar konten dapat dimuat di beberapa halaman, sehingga konten harus dapat digunakan kembali sebanyak mungkin. * Sertakan konten yang ideal: Langkah-langkah dan catatan atau tips terkait yang berisi detail penerapan seperti batas, peringatan, atau cara kerja. * Hindari: Judul atau ringkasan (kami ingin memformat dan menulis sendiri, untuk kasus penggunaan bisnis).

Contoh: Berikut adalah contoh file include untuk langkah-langkah tentang cara menyalin nomor project dari project Google Cloud:

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

Untuk mengetahui informasi selengkapnya, lihat dokumentasi Penerbitan DevSite untuk Menyertakan file.

Menambahkan sertakan ke konten Anda

Untuk menambahkan include ke halaman Anda, gunakan tag include. Tag include menyisipkan konten file yang ditentukan di lokasi tag di halaman Anda.

Berikut adalah contoh tag include untuk file contoh dari bagian sebelumnya:

Contoh


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

Hasil render

  1. Di Konsol Google Cloud, buka Menu lalu IAM & Admin lalu Settings.

    Buka Setelan IAM & Admin

  2. Di kolom Project number, salin nilai.

File cuplikan yang dimigrasikan

Cuplikan dari Composer telah dimigrasikan ke folder third_party/devsite/workspace/en/_shared/snippets. Jika konten Anda menggunakan cuplikan di Composer sebelum dimigrasikan ke DevSite, Anda akan melihat tag include dalam konten yang mirip dengan contoh berikut:

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

Jangan tambahkan file include baru ke folder _shared/snippets.

Publikasi silang

Di DevSite, setiap halaman termasuk dalam satu set konten. Devsite tidak mendukung publikasi silang yang digunakan di Composer, di mana satu halaman dapat dipublikasikan di beberapa pusat bantuan. Sebagai gantinya, Anda dapat menautkan ke halaman di set konten lain dari dalam daftar isi (TOC).

Menambahkan halaman dari set konten yang berbeda ke navigasi Anda

Untuk menautkan ke halaman dari kumpulan konten yang berbeda di navigasi Anda, lakukan langkah-langkah berikut:

  1. Buka file _book.yaml untuk set konten Anda. File _book.yaml adalah tempat Anda mengelola navigasi situs.
  2. Tambahkan judul halaman dan jalur root ke halaman yang ingin Anda tautkan.

Dalam contoh berikut, file _book.yaml untuk Cloud Search ditautkan ke artikel dari set konten Business Continuity.

    - 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

Saat pengguna mengklik link Deploy Verifikasi 2 Langkah di navigasi Cloud Search, mereka akan diarahkan ke halaman di dokumentasi Business Continuity.

Untuk mempelajari lebih lanjut cara memperbarui navigasi situs Anda, lihat Memperbarui navigasi.