Edit This Page

Berpartisipasi dalam SIG Docs

SIG Docs merupakan salah satu kelompok peminatan khusus (special interest groups) dalam proyek Kubernetes, yang berfokus pada penulisan, pembaruan, dan pemeliharaan dokumentasi untuk Kubernetes secara keseluruhan. Lihatlah SIG Docs dari repositori github komunitas untuk informasi lebih lanjut tentang SIG.

SIG Docs menerima konten dan ulasan dari semua kontributor. Siapa pun dapat membuka pull request (PR), dan siapa pun boleh mengajukan isu tentang konten atau komen pada pull request yang sedang berjalan.

Kamu juga bisa menjadi anggota (member), pengulas (reviewer, atau pemberi persetujuan (approver). Peran tersebut membutuhkan akses dan mensyaratkan tanggung jawab tertentu untuk menyetujui dan melakukan perubahan. Lihatlah keanggotaan-komunitas (community-membership) untuk informasi lebih lanjut tentang cara kerja keanggotaan dalam komunitas Kubernetes.

Selebihnya dari dokumen ini akan menguraikan beberapa cara unik dari fungsi peranan tersebut dalam SIG Docs, yang bertanggung jawab untuk memelihara salah satu aspek yang paling berhadapan dengan publik dalam Kubernetes - situs web dan dokumentasi dari Kubernetes.

Ketua umum (chairperson) SIG Docs

Setiap SIG, termasuk SIG Docs, memilih satu atau lebih anggota SIG untuk bertindak sebagai ketua umum. Mereka merupakan kontak utama antara SIG Docs dan bagian lain dari organisasi Kubernetes. Mereka membutuhkan pengetahuan yang luas tentang struktur proyek Kubernetes secara keseluruhan dan bagaimana SIG Docs bekerja di dalamnya. Lihatlah Kepemimpinan (leadership) untuk daftar ketua umum yang sekarang.

Tim dan automasi dalam SIG Docs

Automasi dalam SIG Docs bergantung pada dua mekanisme berbeda: Tim GitHub dan berkas OWNERS.

Tim GitHub

Terdapat dua kategori tim dalam SIG Docs tim (teams) dalam GitHub:

  • @sig-docs-{language}-owners merupakan pemberi persetujuan (approver) dan pemimpin (lead)
  • @sig-docs-{language}-reviewers merupakan pengulas (reviewer)

Setiap tim dapat direferensikan dengan @name mereka dalam komen GitHub untuk berkomunikasi dengan setiap orang di dalam grup.

Terkadang tim Prow dan GitHub tumpang tindih (overlap) tanpa kecocokan sama persis. Untuk penugasan masalah, pull request, dan untuk mendukung persetujuan PR, otomatisasi menggunakan informasi dari berkas OWNERS.

Berkas OWNERS dan bagian yang utama (front-matter)

Proyek Kubernetes menggunakan perangkat otomatisasi yang disebut prow untuk melakukan automatisasi yang terkait dengan isu dan pull request dalam GitHub. Repositori situs web Kubernetes menggunakan dua buah prow plugin:

  • blunderbuss
  • approve

Kedua plugin menggunakan berkas OWNERS dan OWNERS_ALIASES dalam level teratas dari repositori GitHub kubernetes/website untuk mengontrol bagaimana prow bekerja di dalam repositori.

Berkas OWNERS berisi daftar orang-orang yang menjadi pengulas dan pemberi persetujuan di dalam SIG Docs. Berkas OWNERS juga bisa terdapat di dalam subdirektori, dan dapat menimpa peranan karena dapat bertindak sebagai pengulas atau pemberi persetujuan berkas untuk subdirektori itu dan apa saja yang ada di dalamnya. Untuk informasi lebih lanjut tentang berkas OWNERS pada umumnya, lihatlah OWNERS.

Selanjutnya, berkas markdown individu dapat menyimpan daftar pengulas dan pemberi persetujuan pada bagian yang utama, baik dengan menyimpan daftar nama pengguna individu GitHub atau grup GitHub.

Kombinasi dari berkas OWNERS dan bagian yang utama dalam berkas markdown menentukan saran kepada pemilik PR yang didapat dari sistem otomatis tentang siapa yang akan meminta ulasan teknis dan ulasan editorial untuk PR mereka.

Cara menggabungkan pekerjaan

Ketika pull request digabungkan ke cabang (branch) yang digunakan untuk mempublikasikan konten, konten itu dipublikasikan di http://kubernetes.io. Untuk memastikan bahwa kualitas konten yang kita terbitkan bermutu tinggi, kita membatasi penggabungan pull request bagi para pemberi persetujuan SIG Docs. Beginilah cara kerjanya.

  • Ketika pull request memiliki label lgtm dan approve, tidak memiliki label hold, dan telah lulus semua tes, pull request akan digabungkan secara otomatis.
  • Anggota organisasi Kubernetes dan pemberi persetujuan SIG Docs dapat menambahkan komen untuk mencegah penggabungan otomatis dari pull request yang diberikan (dengan menambahkan komen /hold atau menahan komen /lgtm).
  • Setiap anggota Kubernetes dapat menambahkan label lgtm dengan menambahkan komen lgtm
  • Hanya pemberi persetujuan SIG Docs yang bisa menggabungkan pull request dengan menambahkan komen /approve. Beberapa pemberi persetujuan juga dapat melakukan tugas tambahan seperti PR Wrangler atau Ketua Umum SIG Docs.

Selanjutnya

Untuk informasi lebih lanjut tentang cara berkontribusi pada dokumentasi Kubernetes, lihatlah: