Menambahkan dan mengedit konten

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Gunakan jenis konten "Halaman Dasar" Drupal untuk menambahkan dokumentasi tentang API Anda, seperti panduan cara dan dokumen referensi API, ke portal Layanan Developer, dan sertakan konten seperti video, screencast, atau download kode.

Halaman Dokumentasi disiapkan dengan beberapa entri awal yang diatur dalam berbagai kategori seperti "Memulai" dan "Tutorial". Halaman ini adalah titik awal untuk Anda edit. Dengan cara ini, Anda dapat menambahkan entri konten Anda sendiri dan mengatur entri tersebut sesuai keinginan.

Menambahkan halaman beranda Dokumentasi

Secara default, halaman beranda Dokumentasi berada di <siteURL>/documentation di portal developer Anda. Halaman Beranda default portal developer berisi link ke halaman ini di kotak di bagian atas Halaman beranda:

Anda juga dapat menambahkan link Dokumentasi ke halaman ini di menu utama menu portal developer.

Namun, halaman beranda Dokumentasi tidak ada secara default, jadi Anda harus membuat halaman baru di portal developer dengan URL yang benar.

Untuk menambahkan halaman beranda Dokumentasi ke portal developer Anda:

  1. Login ke portal sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Pilih Konten > Tambahkan konten > Halaman dasar di menu administrasi Drupal.
  3. Masukkan judul dokumen, seperti Beranda Dokumentasi, dan konten halaman pertama.
  4. Klik Edit ringkasan untuk menambahkan Ringkasan.
  5. Klik item Setelan Menu di bawah bagian Isi.
  6. Pilih Berikan link menu, tambahkan judul link, lalu pilih <Main menu> di Item Induk.
    Tindakan ini akan menambahkan link ke menu utama untuk Halaman beranda Dokumentasi Anda.
  7. Klik item Setelan jalur URL di bawah bagian Isi.
  8. Batalkan pilihan Buat alias URL otomatis, dan tetapkan alias URL ke dokumentasi.
    Secara default, URL halaman adalah <siteURL>/content/pageName. Dengan menetapkan alias URL, Anda menetapkan URL halaman eksplisit, dalam hal ini ke <siteURL>/documentation.
  9. Simpan halaman.
    Sekarang Anda akan melihat link ke halaman di panel menu, dan link di kotak di halaman beranda sekarang akan berfungsi.
    Sebagai administrator, Anda juga akan melihat tombol administrasi konten seperti Lihat dan Edit. Pengguna non-administrator tidak akan melihatnya.

Menambahkan halaman turunan ke dokumentasi

Saat Anda menambahkan halaman turunan ke dokumentasi:

  1. Login ke portal sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Pilih Konten > Tambahkan konten > Halaman dasar di menu administrasi Drupal.
  3. Masukkan judul halaman dan konten.
  4. Klik Edit ringkasan untuk menambahkan Ringkasan.
  5. Klik item Setelan Menu di bawah bagian Isi.
  6. Pilih Berikan link menu, tambahkan item menu halaman beranda dokumentasi.



    Tindakan ini akan menambahkan halaman saat ini sebagai turunan dari menu utama untuk Halaman beranda Dokumentasi Anda.
  7. Sekarang Anda akan melihat link ke halaman di menu Halaman beranda Dokumentasi.

Mengedit halaman dokumentasi

Untuk mengedit halaman:

  1. Login ke portal sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Buka halaman di portal developer.
    Anda juga dapat mengklik Konten di menu administrasi Drupal untuk mencantumkan semua halaman dan memilih salah satunya.
  3. Pilih tab Edit di halaman.


  4. Buka editor visual dengan memilih HTML Lengkap atau HTML yang Difilter di menu drop-down Format Teks di bawah bagian Isi.
    Anda akan melihat konten halaman yang ditampilkan di editor.
  5. Edit halaman sesuai kebutuhan.

  6. Klik Simpan.

Menampilkan halaman dokumentasi apa pun

Untuk menampilkan konten dokumen:

  1. Login ke portal sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Pilih Konten di menu administrasi Drupal.
  3. Pilih dokumen yang ingin Anda lihat.

Mengatur ulang urutan halaman

Anda dapat mengubah urutan dan tingkat tingkatan halaman di menu Beranda Dokumentasi.

Untuk menyusun ulang halaman di menu Beranda Dokumentasi:

  1. Login ke portal sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Di menu administrasi Drupal, pilih Struktur > Menu > Menu utama.
  3. Setiap item dalam menu memiliki ikon di sebelah kiri namanya. Jika Anda tidak melihat ikon, klik Sembunyikan bobot baris.
  4. Untuk memindahkan item, klik dan tarik ikon untuk memindahkannya ke lokasi baru.
    Menarik item dengan item turunan juga akan memindahkan turunan.


  5. Klik Save Configuration.

Mengedit halaman footer

Footer untuk portal berisi tiga ikon media sosial untuk Twitter, Facebook, dan LinkedIn serta link dengan URL berikut:

  • Kebijakan Privasi ke URL <siteURL>/privacy-policy
  • Persyaratan & Penggunaan ke URL <siteURL>/terms-use
  • Halaman kontak ke URL <siteURL>/contact-us

Edit halaman ini untuk menambahkan konten Anda sendiri.

Jika halaman ini tidak ada, buat halaman tersebut:

  1. Login ke portal sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Pilih Konten > Tambahkan konten > Halaman dasar di menu administrasi Drupal.
  3. Masukkan judul dokumen, seperti Kebijakan Privasi, dan konten halaman.
  4. Klik Edit ringkasan untuk menambahkan Ringkasan.
  5. Klik item Setelan jalur URL di bawah bagian Isi.
  6. Pilih Buat alias URL otomatis, lalu tetapkan alias URL ke privacy-policy.
    Secara default, URL halaman adalah <siteURL>/content/pageName. Dengan menetapkan alias URL, Anda menetapkan URL halaman yang eksplisit, dalam hal ini ke <siteURL>/privacy-policy.
  7. Simpan halaman.
  8. Ulangi proses ini untuk halaman Persyaratan & Penggunaan dan Kontak.

Untuk mengedit konten halaman footer, seperti halaman Kebijakan Privasi, Persyaratan Penggunaan, atau Hubungi Kami, di portal developer:

  1. Login ke portal sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Buka halaman dengan mengklik linknya di footer. Misalnya, klik link Kebijakan Privasi.
  3. Klik tab Edit di halaman untuk membuka editor.
  4. Ubah konten halaman Kebijakan Privasi sebagaimana mestinya.
  5. Klik Simpan.
  6. Ulangi proses ini untuk halaman Persyaratan & Penggunaan dan Kontak.

Untuk mengedit ikon media sosial, seperti ikon Twitter, Facebook, dan LinkedIn, di portal developer:

  1. Login ke portal sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Pilih Struktur > Blok di menu administrasi Drupal.
  3. Scroll halaman Blok ke bawah hingga Anda melihat blok Footer Default Seluruh Situs.
  4. Pilih link konfigurasi yang sesuai dengan blok Footer Default di Seluruh Situs.
  5. Di area Konten Kustom, klik kanan ikon media sosial, lalu pilih Edit Link dari menu pop-up. Atau, hapus ikon dari area Konten Kustom untuk menghapusnya.
  6. Pilih Simpan blok untuk menyimpan perubahan.

Menambahkan JavaScript ke halaman portal

Anda dapat menambahkan JavaScript ke halaman portal mana pun. Cara termudah untuk menambahkan JavaScript adalah dengan mengedit halaman, lalu:

  1. Pilih Full HTML sebagai Text Format.
  2. Pilih tombol Sumber untuk mengedit kode sumber HTML halaman.
  3. Tambahkan JavaScript Anda ke halaman. Misalnya, untuk memunculkan kotak pemberitahuan saat halaman dimuat, tambahkan kode berikut:

    <script language="JavaScript">
    alert('Welcome to my page!');
    </script>

Beberapa pertimbangan dalam menggunakan JavaScript:

  • Jika Anda akan mereferensikan file JavaScript, jangan melakukannya dalam kode sumber node karena akan membuat link statis. Sebagai gantinya, gunakan kode PHP agar Anda dapat membuat link dinamis. Dengan begitu, jika lokasi file JavaScript berubah, Anda tidak perlu memperbarui semua halaman portal yang mereferensikannya.
  • Jika Anda ingin menyertakan file JavaScript, tambahkan ke tema portal. Atau, jika merupakan bagian dari modul Drupal, tambahkan ke modul.
  • Anda juga dapat menggunakan fungsi drupal_add_js Drupal untuk menambahkan JavaScript di Drupal. Untuk informasi selengkapnya, lihat https://api.drupal.org/api/drupal/includes!common.inc/function/drupal_add_js/7.

Sebaiknya periksa konten Anda untuk melihat adanya link yang rusak. Secara default, portal developer disiapkan untuk memeriksa berbagai jenis halaman guna menemukan link yang rusak. Misalnya, link diperiksa di halaman dasar, artikel, entri blog, dan topik forum.

Untuk menambahkan atau menghapus jenis halaman dari pemeriksaan link:

  1. Di menu administrasi Drupal, pilih Modules dan pastikan modul Link Checker diaktifkan.
  2. Di menu administrasi Drupal, pilih Konfigurasi > Penulisan konten > Pemeriksa link.
  3. Konfigurasikan jenis konten yang ingin Anda pindai untuk menemukan link yang rusak.

Mengonfigurasi penelusuran

Portal developer menyediakan mesin telusur bawaan yang diterapkan oleh Apache Solr, yang menggunakan library penelusuran Apache Lucene. Ini adalah mesin telusur untuk situs itu sendiri, yang diakses pengguna melalui kotak penelusuran di pojok kanan atas semua halaman portal.

Mesin telusur eksternal, seperti Google, juga dapat mengindeks portal Anda. Portal developer memungkinkan Anda mengontrol apakah mesin telusur eksternal dapat mengindeks portal Anda atau tidak.

Mengonfigurasi Apache Solr

Anda dapat mengonfigurasi Apache Solr untuk mengontrol jenis konten yang akan diindeks, memaksa indeks, dan melakukan tugas konfigurasi tambahan.

Untuk mengonfigurasi Apache Solr:

  1. Login ke portal sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Di menu administrasi Drupal, pilih Konfigurasi > Penelusuran dan metadata > Penelusuran Apache Solr.
  3. Gunakan halaman ini untuk mengonfigurasi Apache Solr.

Menonaktifkan pengindeksan Google

Sebaiknya Anda juga mengindeks konten dan menyediakannya untuk mesin telusur. Secara default, konten Anda diindeks oleh pengindeksan Google. Namun, Anda memiliki opsi untuk menonaktifkan pengindeksan Google. Anda mungkin ingin melakukannya jika portal developer Anda belum siap untuk digunakan publik sehingga Anda tidak ingin konten Anda dapat ditelusuri secara publik.

Untuk menonaktifkan pengindeksan Google:

  1. Login ke portal sebagai pengguna dengan hak istimewa admin atau pembuatan konten.
  2. Pilih Modul di menu administrasi Drupal.
  3. Aktifkan modul Metatag.
  4. Klik Simpan konfigurasi.
  5. Di menu administrasi Drupal, pilih Konfigurasi > Penelusuran dan metadata > Metatag.
  6. Pilih operasi Ganti untuk Jenis global.
  7. Klik bagian Lanjutan untuk membukanya.

  8. Centang kotak Cegah mesin telusur mengindeks halaman ini.
  9. Klik Simpan.

Perhatikan bahwa ada opsi terkait mesin telusur lainnya di bagian Lanjutan pada halaman Global. Misalnya, Anda dapat mencentang kotak untuk mencegah mesin telusur mengikuti link di halaman. Centang satu atau beberapa kotak centang ini sesuai kebutuhan.

Mendokumentasikan cara mendaftarkan aplikasi

Penting untuk menyertakan petunjuk tentang cara developer mendaftarkan aplikasi mereka melalui portal developer Anda. Anda dapat menggunakan petunjuk berikut sebagai titik awal — petunjuk ini membahas cara mendaftarkan aplikasi melalui portal developer default.

Untuk mengonfigurasi cara developer mendaftarkan aplikasi di portal Anda, lihat Mengonfigurasi pendaftaran aplikasi untuk mengetahui informasi selengkapnya. Jika Anda mengubah proses pendaftaran aplikasi, ubah contoh petunjuk di bawah sebagaimana mestinya.

Untuk mendaftarkan aplikasi melalui portal developer default:

  1. Pilih Aplikasi saya di bawah nama pengguna Anda di menu login.
  2. Klik ikon aplikasi baru Tambahkan (+).

  3. Masukkan nilai yang sesuai di halaman Tambahkan aplikasi:
    Nama aplikasi Berikan Nama Aplikasi yang unik untuk aplikasi Anda.
    URL Callback

    Jika diperlukan, berikan URL callback tempat panggilan OAuth akan ditampilkan.

    Secara default, nilai ini diperlukan meskipun API Anda tidak menggunakan OAuth. Jika API Anda tidak menggunakan OAuth, masukkan nilai dummy seperti my.site.com.
    Produk Pilih satu atau beberapa produk API.
  4. Klik Buat Aplikasi untuk mendaftarkan aplikasi dan membuat kunci API untuk aplikasi.