Cara Membuat Wiki Internal Sederhana Menggunakan Gitbook

GitBook adalah platform yang memungkinkan Anda membangun situs dokumentasi atau wiki perusahaan. Anda dapat menggunakannya untuk mendokumentasikan segala macam hal, mulai dari kode hingga API dan cara menggunakan produk perangkat lunak.

GitBook menggunakan proses yang mirip dengan repositori GitHub. Salinan utama dokumentasi bertindak sebagai salinan “master”. Anda kemudian dapat membuat “draf”, yang mirip dengan “cabang”.

Proses ini memungkinkan banyak pengguna untuk bekerja di satu situs dokumentasi sambil menangani atau mencegah konflik. Ini juga memungkinkan perubahan dari cabang yang berbeda melalui proses peninjauan sebelum Anda menggabungkannya.

Cara Mulai Menggunakan GitBook

Anda dapat memilih dari beberapa paket harga GitBook. Harga akan tergantung pada apakah Anda menggunakan GitBook untuk proyek sumber terbuka, penggunaan pribadi, atau kolaborasi tim pribadi. GitBook gratis untuk digunakan jika Anda menggunakannya untuk proyek sumber terbuka.

GitBook mendukung Markdown, bahasa markup populer dengan banyak manfaat untuk menulis atau mendokumentasikan di web.

GitBook juga terintegrasi dengan GitHub, platform untuk hosting, penyimpanan, dan pengeditan kode. Anda dapat menautkan akun GitBook Anda langsung ke akun GitHub Anda dengan masuk menggunakan kredensial GitHub Anda.

  1. Daftar ke GitBook. Jika Anda memiliki akun GitHub sendiri, Anda dapat mengklik Daftar Dengan GitHub.
  2. Setelah Anda masuk, GitBook akan mengarahkan Anda ke wiki internal baru. Ini juga akan mengisi wiki Anda dengan beberapa konten sampel.

Ikhtisar Antarmuka GitBook

GitBook memiliki beberapa fungsi yang memungkinkan Anda membuat dan membuat perubahan pada situs dokumentasi Anda.

  1. Panel atas memungkinkan Anda membuat draf baru, melihat riwayat perubahan, atau melihat diskusi atau lampiran lainnya.
  2. Bilah sisi paling kiri memungkinkan Anda membuat banyak spasi. Anda dapat menggunakan ruang terpisah untuk proyek yang berbeda sehingga Anda dapat memisahkan dan mengatur area dokumentasi Anda. Anda dapat memperluas atau menutup bilah sisi.
  3. Panel kiri berfungsi sebagai menu untuk situs dokumentasi. Anda dapat melihat halaman dalam situs dokumentasi Anda, dan menggunakannya untuk membuat grup dan halaman bersarang. Anda juga dapat menavigasi di seluruh situs menggunakan tautan yang disediakan.
  4. Panel bawah mencakup tombol yang penting untuk proses kontrol versi. Anda dapat menambahkan nama untuk draf, menggabungkan perubahan, atau mengirimkan perubahan untuk ditinjau.


See also  Cara Menambahkan Penyorotan Sintaks ke Blok Kode di React

Cara Membuat Draf Baru

Anda dapat membuat draf baru dengan membuat Permintaan Perubahan baru dan membuat perubahan di dalamnya.

  1. Di panel atas, klik Perubahan permintaan.
  2. Pada panel baru yang muncul di sisi kanan, klik pada Konsep tab. Ini akan menunjukkan kepada Anda semua draf aktif Anda.
  3. Dari sini, Anda dapat mengklik draf yang ada untuk membukanya. Untuk membuat draf baru, klik Permintaan perubahan barudan tunggu hingga halaman selesai dimuat.
  4. Di panel bawah, klik Masukkan Subjek. Ini akan membuka jendela tempat Anda dapat memberi nama draf baru. Sebagai contoh, Halaman Baru – Cara Mengatur Basis Kode.

Cara Membuat Halaman dan Grup

Setelah Anda memiliki draf, Anda dapat mulai membuat perubahan pada dokumentasi. GitBook menyimpan perubahan Anda di dalam draf, sehingga tidak memengaruhi salinan master. Anda dapat menggunakan bilah sisi kiri untuk menambahkan halaman dan grup halaman.

  1. Buat halaman baru dengan mengklik Halaman baru tautan di bagian bawah bilah sisi, dan pilih Halaman dokumen baru dari tarik-turun. Atau, Anda dapat mengarahkan kursor ke bawah halaman yang ada dan klik pada warna biru plus tombol.
  2. Untuk membuat Grup Halaman baru, klik Halaman barudan pilih Grup baru pilihan dari dropdown.
  3. Anda dapat mengganti nama halaman dengan mengklik tiga titik di sebelah halaman atau grup, dan memilih Ganti nama.
  4. Mulai tambahkan konten untuk mengisi halaman baru Anda. Anda dapat menambahkan konten sederhana seperti teks atau judul. GitBook juga memungkinkan Anda untuk menambahkan blok konten lain seperti gambar, lampiran file, tabel, tab, atau cuplikan kode. Ada juga opsi untuk menambahkan integrasi lain seperti penyematan YouTube atau konten Google Documents.
  5. Klik pada Tampilan berbeda tombol di panel bawah untuk melihat perbedaan antara draf Anda dan salinan dokumentasi master asli.
  6. Setelah Anda selesai menulis konten Anda, Anda dapat mengklik Menggabungkan, Kirim dan gabungkanatau Kirim untuk ditinjau.


See also  Cara Membuat Home windows Mengabaikan HDD Eksternal dan Boot Lebih Cepat

Anda dapat mengakses tautan berbagi dari panel atas GitBook. Anda harus keluar dari draf dan melihat salinan dokumentasi master untuk dapat melihat tautan.

  1. Secara default, visibilitas situs dokumentasi Anda “tidak terdaftar”. Ini berarti Anda dapat mengakses situs dokumentasi menggunakan tautan pribadi, dan bukan melalui mesin pencari. Di panel atas, klik pada Tidak terdaftar tombol.
  2. Pilih pengaturan visibilitas yang Anda inginkan dari dropdown. Perhatikan bahwa GitBook mungkin mengunci pengaturan visibilitas tertentu, dan Anda mungkin perlu memutakhirkan untuk mengaksesnya.
  3. Di bawah daftar pengaturan visibilitas, ada tautan yang dapat Anda bagikan dengan pengguna lain yang akan menggunakan situs dokumentasi Anda. Salin tautan ini untuk membagikannya dengan orang lain.
  4. Di bawah tautan, klik Pengaturan tautan dan domain. Di sinilah Anda dapat menautkan nama domain khusus, atau memodifikasi bagian dari URL. Jika Anda menggunakan domain khusus, Anda dapat melihat dokumentasi Gitbook tentang cara mengonfigurasi DNS Anda dengan benar.

Membuat Dokumentasi Menggunakan GitBook

GitBook memungkinkan Anda membuat dan bekerja secara kolaboratif di situs dokumentasi atau wiki perusahaan. GitBook meminjam konsep dari GitHub seperti cabang dan penggabungan untuk mengontrol salinan master dan mengelola konflik apa pun.

Anda dapat membuat draf baru untuk menambahkan perubahan individual Anda ke dokumentasi. Di dalam draf, Anda dapat membuat perubahan pada konten, serta menambahkan halaman atau grup halaman baru. Setelah Anda selesai membuat perubahan, Anda dapat menggabungkannya atau mengirimkannya untuk ditinjau.

Jika Anda membuat dokumentasi internal untuk kode Java Anda, Anda mungkin ingin menjelajahi Javadoc. Javadoc memungkinkan Anda untuk mendokumentasikan kode Java Anda secara otomatis.

See also  Menguji Komponen React Menggunakan Jest dan Pustaka Pengujian React