Bagikan melalui

Cara berkontribusi pada dokumentasi SQL Server

Berlaku untuk:SQL ServerAzure SQL DatabaseAzure Synapse AnalyticsAnalytics Platform System (PDW)

Siapa pun dapat berkontribusi pada dokumentasi SQL Server. Ini termasuk memperbaiki kesalahan ketik, menyarankan penjelasan yang lebih baik, dan meningkatkan akurasi teknis. Artikel ini menjelaskan cara memulai kontribusi konten dan cara kerja prosesnya.

Ada dua alur kerja utama yang dapat Anda gunakan untuk berkontribusi:

Alur kerja Deskripsi
Sunting di browser Anda Cocok untuk pengeditan kecil dan cepat dari artikel apa pun.
Edit secara lokal dengan alat Baik untuk pengeditan yang lebih kompleks, pengeditan yang melibatkan beberapa artikel, dan kontribusi yang sering.

Tim konten Dokumen Data memvalidasi semua kontribusi publik untuk akurasi dan konsistensi teknis.

Mengedit di browser Anda

Anda dapat melakukan pengeditan sederhana ke konten SQL Server di browser Anda lalu mengirimkannya ke Microsoft. Untuk informasi selengkapnya, lihat gambaran umum panduan kontributor.

Langkah-langkah berikut meringkas prosesnya:

  1. Pada halaman yang ingin Anda sarankan perubahannya, pilih Kebab (tiga titik vertikal)di dekat Dalam artikel ini.
  2. Pilih Edit. Browser membawa Anda ke repositori GitHub untuk file sumber artikel tersebut.
  3. Di file sumber, pilih ikon Pensil di kanan atas. Jika ikon ini tidak muncul, Anda mungkin perlu masuk ke akun GitHub Anda terlebih dahulu. GitHub mengembalikan halaman pengeditan.
  4. Edit teks untuk mengusulkan perubahan. Jika Anda memerlukan bantuan dalam memformat teks baru atau yang diubah, lihat Cheatsheet Markdown.
  5. Setelah Anda melakukan pengeditan, gulir kembali ke bagian atas halaman dan pilih Terapkan perubahan.
    1. Dalam kotak dialog Terapkan pesan , berikan nama untuk permintaan pull Anda, seperti Memperbaiki kesalahan ketik.
    2. Dalam kotak Tambahkan deskripsi tambahan opsional, berikan penjelasan singkat tentang perubahan Anda.
    3. Pilih Usulkan perubahan untuk masuk ke halaman Membandingkan perubahan .
  6. Pada halaman Membandingkan perubahan , pilih Buat permintaan pull untuk masuk ke halaman Buka permintaan pull .
  7. Pada halaman Buka permintaan pull, pilih Buat permintaan pull untuk mengirimkan permintaan pull Anda ke tim konten.

GIF berikut menunjukkan proses end-to-end untuk mengirimkan perubahan melalui browser Anda:

Cuplikan layar Edit Dokumen SQL.

Setelah Anda membuat permintaan pull, tim konten meninjau perubahan yang Anda usulkan. Jika mereka menerima perubahan Anda, mereka menggabungkannya ke dalam dokumentasi dan menerbitkannya. Anda menerima pemberitahuan email tentang status permintaan pull Anda, tergantung pada pengaturan pemberitahuan Github Anda.

Edit secara lokal dengan menggunakan alat

Opsi lain adalah fork repositori atau azure-docs dan mengkloningnya sql-docs secara lokal ke komputer Anda. Anda kemudian dapat menggunakan editor Markdown dan klien git untuk mengirimkan perubahan. Alur kerja ini bagus untuk pengeditan yang lebih kompleks atau melibatkan beberapa file. Ini juga bagus untuk kontributor yang sering berkontribusi pada dokumentasi teknis Microsoft.

Untuk berkontribusi dengan metode ini, lihat artikel berikut ini:

Jika Anda mengirimkan permintaan pull dengan perubahan signifikan pada dokumentasi, Anda menerima komentar di GitHub yang meminta Anda untuk mengirimkan Perjanjian Lisensi Kontribusi (CLA) online. Anda harus mengisi formulir online sebelum permintaan pull Anda dapat diterima.

Gambaran umum: repositori sql-docs

Bagian ini menyediakan lebih banyak panduan tentang bekerja di sql-docs repositori.

Penting

Informasi di bagian ini khusus untuk sql-docs. Jika Anda mengedit artikel SQL di dokumentasi Azure, lihat Readme untuk repositori azure-docs di GitHub.

Repositori sql-docs menggunakan beberapa folder standar untuk mengatur konten.

Map Deskripsi
dokumen Berisi semua isi SQL Server yang diterbitkan. Subfolder secara logis mengatur area konten yang berbeda.
dokumen/termasuk Berisi sertakan file. File-file ini adalah blok konten yang dapat disertakan dalam satu atau beberapa artikel lainnya.
./media Setiap folder dapat memiliki satu media subfolder untuk gambar artikel. Folder tersebut media memiliki subfolder dengan nama yang sama dengan artikel di mana gambar tersebut muncul. Gambar harus berupa .png file dengan semua huruf kecil dan tanpa spasi.
TOC.yml File daftar isi. Setiap subfolder memiliki opsi untuk menggunakan satu TOC.yml file.

Sumber daya kontributor

Kiat

Jika Anda memiliki umpan balik produk alih-alih umpan balik dokumentasi, berikan umpan balik.

Langkah selanjutnya

Jelajahi repositori sql-docs di GitHub.

Temukan artikel, kirim perubahan, dan bantu komunitas SQL Server.

Terima kasih.

  • Last updated on