“Anyone who has never made a mistake has never tried anything new” - Albert Einstein.

Halaman ini mempersiapkan diri Anda untuk berkontribusi dalam situs.


DAFTAR ISI

  1. Struktur Direktori
  2. Instalasi lokal
  3. Memeriksa kondisi Jekyll site

Situs hidrokit dan hidrokit-nb dibuat menggunakan Jekyll & GitHub Pages dengan menggunakan remote-theme dari Just the Docs oleh Patrick Marsceill. Disarankan untuk membaca manual penggunaan tema di Just the Docs agar mengetahui fitur yang tersedia.

Dianjurkan untuk melakukan instalasi pada mesin lokal sebelum melakukan pull request agar memudahkan saat melakukan pengembangan/perbaikan. Baca bagian instalasi lokal untuk lebih lanjut.

Untuk memulai kontribusi dalam situs, berikut yang harus dipersiapkan/diketahui:

  • Terbiasa dengan penulisan Markdown, HTML, dan CSS.
  • Sudah memasang/instalasi Ruby, Jekyll, dan Bundler.
  • Mengetahui menggunakan Jekyll (front matter dan _config.yml)
  • Diasumsikan sudah memahami menggunakan Git dan Github.

Struktur Direktori

+hidrokit@gh-pages // +hidrokit-nb/docs
|   Gemfile
|   index.md
|   README.md
|   _config.yml
|   _config_local.yml
|   
+---assets
|   +---images
|   |   +---favicon
|   |   \---panduan
|   \---js
|           
\---halaman

Keterangan:

  • Gemfile: file Gem yang digunakan untuk instalasi Jekyll.
  • index.md: halaman depan situs.
  • _config.yml: konfigurasi yang digunakan saat deployment di GitHub.
  • _config_local.yml: konfigurasi yang digunakan untuk mesin lokal.
  • assets/: Media Directory | Direktori khusus penyimpanan media.
    • images/: berisikan media gambar yang digunakan untuk situs.
    • js/: berisikan file yang digunakan untuk fitur pencarian di situs.
  • halaman/: Page Directory | Direktori khusus untuk seluruh halaman dalam situs.

Direktori/files bisa ditambahkan jika diperlukan.

Instalasi lokal

Langkah ini tidak jauh berbeda dengan yang ada di halaman Just the Docs. Diasumsikan bahwa Ruby beserta Jekyll dan Bundler sudah terinstalasi, jika belum, baca Quickstart untuk informasi lebih lanjut.

  • Buka command prompt/terminal, pastikan sudah berada di direktori hidrokit cabang gh-pages atau hidrokit-nb/docs/. Masukan perintah berikut untuk melakukan instalasi:
$ bundle install
  • Jalankan server lokal dengan menggunakan konfigurasi lokal.
$ bundle exec jekyll serve --config _config_local.yml
  • Buka browser dan buka halaman http://localhost:4000

  • (Opsional) Memperbarui file index untuk fitur pencarian.

$ bundle exec just-the-docs rake search:init

Memeriksa kondisi Jekyll site

Sebelum melakukan pull request, hasil ubahan Anda bisa di cek menggunakan gem html-proofer. Sangat disarankan melakukan langkah ini terlebih dahulu sebelum meminta penggabungan. Travis-ci melakukan pengecekan dengan metode ini.

  • Dari terminal, build situs anda dengan perintah:
$ bundle exec jekyll build --config _config_local.yml

Pastikan menggunakan _config_local.yml karena _config.yml hanya digunakan untuk GitHub-Pages.

  • Periksa kondisi hasilnya dengan menulis perintah:
$ bundle exec htmlproofer ./_site --assume-extension --disable-external

Hasil build dianggap baik jika tidak ada pesan error.

Jika sukses, lakukan pull request. ✨


Masih mau baca?

Dokumentasi Hidrologi Python