Halaman ini berisikan panduan menambahkan notebook anda di halaman kumpulan notebook.

Daftar Isi

  1. Persiapan
  2. Menambahkan Notebook
    1. Buka dokumen YAML kategori
    2. Format penulisan
    3. Melakukan pull request

Persiapan


Menambahkan Notebook

Tentukan kategori yang sesuai dengan notebook Anda. Gunakan kategori umum jika tidak sesuai dengan kategori demo/hidrokit. Ada tiga YAML file untuk masing-masing kategori. Notebook bisa lebih dari satu kategori, hanya perlu melakukan langkah pengubahan YAML file sebanyak tiga kali.

Buka dokumen YAML kategori

  • Pastikan Anda berada di repo Anda (yang selalu ditandai dengan forked from taruma/hidrokit-nb) dan sudah paling terbaru. Cari file dengan memilih pilihan Find File.
find file button
  • Cari file YAML sesuai kategori. Untuk kategori umum, bernama umum.yml; Untuk kategori hidrokit, bernama hidrokit.yml; Untuk kategori demo, bernama demo.yml. Buka file dengan menekan enter atau memilih docs/_data/{kategori}.yml.
    Catatan: Anda bisa membuka berkas tersebut pada direktori docs/_data/.
find yaml file
  • Klik gambar pensil untuk melakukan perubahan.
edit yaml file
  • Tambah informasi notebook Anda di barisan paling bawah.

Format penulisan

  • Tambahkan informasi notebook Anda dengan menggunakan format sebagai berikut:
- title       : >-
    {{ judul singkat notebook }}
  notebook    : {{ nama berkas notebook tanpa .ipynb }}
  date        : {{ isi tanggal dengan format YYYY-MM-DD }}
  author      : {{ pengunggah }}
  version     : {{ versi notebook }}
  • Catatan:
    • untuk author isikan nama username github.
    • untuk version, jika notebook tidak memiliki versi, isikan dengan nilai 1.0.0.
    • pastikan isian notebook sesuai dengan penamaan berkasnya.
  • Contoh pengisian informasi notebook:
    Saya ingin menambahkan notebook saya yang berjudul “Tutorial satu” dengan nama berkas “taruma_tutorial_satu.ipynb” yang telah masuk pada tanggal 13 Juli 2019.
- title       : >-
    Tutorial satu
  notebook    : taruma_tutorial_satu
  date        : 2019-07-13
  author      : taruma
  version     : 1.0.0
add new notebook info
  • Jika telah selesai mengubah dokumen, lanjutkan dengan memilih Commit changes. Sertakan juga info commit jika diperlukan.
commit changes
  • Jika notebook Anda ingin disertakan pada kategori lain, ulangi langkah diatas dengan berkas YAML yang berbeda. Jika sudah selesai, lanjutkan dengan melakukan pull request.

Melakukan pull request

  • Buka halaman repo Anda, dan lakukan pull request. Langkah melakukan pull request sama dengan langkah pada dihalaman mengunggah notebook.
pull request

🎉🎊 Selamat! Anda telah membuat Pull Request!! 🎊🎉

Kami menanti kontribusi Anda berikutnya. 👍👍