Cara berkontribusi pada dokumentasi SQL Server

  • Artikel

Berlaku untuk:SQL ServerAzure SQL DatabaseAzure Synapse Analytics AnalyticsPlatform 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
Edit 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 SQL memvalidasi semua kontribusi publik untuk akurasi dan konsistensi teknis.

Edit 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 tempat Anda memiliki umpan balik, pilih ikon Pensil di kanan atas.
  2. Pada halaman berikutnya, pilih ikon Pensil di kanan atas. Jika ikon ini tidak muncul, Anda mungkin perlu masuk ke akun GitHub Anda terlebih dahulu.
  3. Pada halaman berikutnya, di jendela Edit teks file , buat pengeditan Anda langsung ke teks yang ingin Anda ubah. Jika Anda memerlukan bantuan dalam memformat teks baru atau yang diubah, lihat Cheatsheet Markdown.
  4. Setelah Anda melakukan pengeditan, di bawah Terapkan perubahan:
    1. Dalam kotak teks pertama, masukkan deskripsi singkat tentang perubahan yang Anda buat.
    2. Dalam kotak Tambahkan deskripsi tambahan opsional, berikan penjelasan singkat tentang perubahan Anda.
  5. Pilih Usulkan perubahan file.
  6. Pada halaman Membandingkan perubahan , pilih Buat permintaan pull.
  7. Pada halaman Buka permintaan pull, pilih Buat permintaan pull.

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

Screenshot of Edit SQL Docs.

Edit secara lokal dengan alat

Opsi pengeditan 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 ke dokumentasi teknis Microsoft.

Untuk berkontribusi dengan metode ini, lihat artikel berikut ini:

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

Pengenalan

Jika perubahan Anda diterima, Anda dikenali sebagai kontributor di bagian atas artikel.

Screenshot of Content contribution recognition.

Gambaran umum 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.

Folder 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 pada gilirannya media memiliki subfolder dengan nama yang sama dengan artikel tempat gambar muncul. Gambar harus berupa file .png dengan semua huruf kecil dan tanpa spasi.
TOC.MD File daftar isi. Setiap subfolder memiliki opsi untuk menggunakan satu TOC. File MD.

Berlaku untuk menyertakan

Setiap artikel SQL Server berisi applies-to file include setelah judul. Ini menunjukkan area atau versi SQL Server apa yang berlaku untuk artikel ini.

Pertimbangkan contoh Markdown berikut yang menarik dalam file sertakan applies-to-version/sql-asdb-asa-pdw.md .

[!INCLUDE [SQL Server Azure SQL Database Synapse Analytics PDW](../includes/applies-to-version/sql-asdb-asdbmi-asa-pdw.md)]

Ini menambahkan teks berikut di bagian atas artikel:

Screenshot of Applies to text.

Untuk menemukan file terapkan yang benar untuk disertakan untuk artikel Anda, gunakan tips berikut:

  • Untuk daftar yang umum digunakan termasuk, lihat SQL Server menyertakan file untuk penerapan versi dan berlaku untuk.
  • Lihat artikel lain yang mencakup fitur yang sama atau tugas terkait. Jika Anda mengedit artikel tersebut, Anda dapat menyalin Markdown untuk tautan yang diterapkan-untuk menyertakan (Anda dapat membatalkan pengeditan tanpa mengirimkannya).
  • Cari dokumen/menyertakan direktori untuk file yang berisi teks applies-to. Anda dapat menggunakan tombol Temukan di GitHub untuk memfilter dengan cepat. Pilih file untuk melihat bagaimana rendernya.
  • Perhatikan konvensi penamaan. Jika nama berisi beberapa x karakter dalam string, biasanya tempat penampung menunjukkan kurangnya dukungan untuk layanan. Misalnya, appliesto-xx-xxxx-asdw-xxx-md.md menunjukkan dukungan hanya untuk Azure Synapse Analytics, karena hanya asdw dieja, sedangkan bidang lain memiliki x.
  • Beberapa menyertakan tentukan nomor versi, seperti tsql-appliesto-ss2017-xxxx-xxxx-xxx-md.md. Hanya gunakan ini termasuk file ketika Anda tahu fitur diperkenalkan dengan versi SQL Server tertentu.

Sumber daya kontributor

Tip

Jika Anda memiliki umpan balik produk daripada umpan balik dokumentasi, berikan umpan balik tentang produk SQL Server di sini.

Konten terkait

Jelajahi repositori sql-docs di GitHub.

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

Terima kasih.