Hi, sudah lama sekali tidak menulis blog. Kali ini gw mendapatkan tugas dari kantor untuk membuat sebuah dokumentasi untuk tim apps. Selama ini gw berpikir dengan menggunakan swagger maka semua sudah selesai, nyatanya tidak seperti itu. Beberapa merasa kesulitan karena API yang dibuat hanya menginfokan mengenai penggunaan request dan response. Berangkat darisana, beberapa developer berniat untuk membuat dokumentasi di confluence, ada juga yang menyarankan menggunakan apiary. Darisana gw teringat mengenai dokumentasi yang pernah dishare di hackaton yang pernah gw jalanin di 2016 bersama BCA. Mereka menggunakan sebuah dokumentasi bernama slate.
Slate merupakan sebuah dokumentasi yang sifatnya static dan elegant seperti yang tertulis pada halaman github resminya disini. Hanya saja yang jadi masalah disini buat gw adalah karena slate dibuat based on bahasa pemrograman ruby dimana itu bukan expertise yang gw miliki. Tetapi itu sudah bukan masalah lagi karena ada yang namanya docker. Kenapa ga jadi masalah? Karena dengan menggunakan docker, gw ga bakal pusing lagi untuk instalasi ruby di local gw, cukup install docker dan semua akan berjalan. Oleh karena itu gw akan ajarin cara instalasi yang sangat simple ini. Buat yang belum pernah belajar docker bisa baca-baca blog gw dipost yang terdahulu ya.
Sebelum memulai menjalankan slate di local, bisa kita mulai dengan melakukan clone terlebih dahulu ke template default slate. Bisa diclone dari sini ya. Setelah selesai clone, sebenarnya part yang kita butuhkan untuk menjalankan slate di local hanya di folder source, jadi kita bisa keluarkan folder source sendiri dari direktori yang sudah di clone. Nah langkah kedua setelah clone adalah pastikan kalian sudah menginstall docker. Gw anggap kalian sudah menginstall docker di laptop ya, jangan minta diajarin lagi gimana cara install docker di laptop hadeh.
Untuk command yang digunakan adalah sebagai berikut.
|
1 |
docker run -p 4567:4567 -v "path/to/source/slate":/app/slate/source -d pedrocesarti/slate-docker |
Setelah tunggu beberapa saat, kalian bisa langsung buka di browser kalian dengan url http://localhost:4567/ . Hasilnya akan seperti berikut ini :
Gampang banget bukan? Ga perlu install apa-apa, cuma perlu docker dan sedikit magic command. Untuk membuat versi dokumentasi kalian sendiri, bisa oprek-oprek langsung di index.html.md. Nah buat yang mau liat versi kerennya slate, bisa liat di docsnya punya bca disini.
Demikian sedikit tutorial simple untuk slate dari gw, untuk sumbernya bisa dibaca dari sini ya.