Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Open Source Geospatial Foundation
- Penulis teknis:
- flicstar
- Nama project:
- Meninjau Panduan Memulai OSGeoLive
- Durasi project:
- Durasi standar (3 bulan)
Project description
Tujuan
- Perbarui dokumen agar tetap terbaru, akurat, dan relevan.
- Buat template untuk memastikan konsistensi di seluruh dokumen, dan untuk Panduan Memulai baru yang ditambahkan pada masa mendatang.
Audiens
- Pengguna baru OSGeo live
- Penulis Panduan Memulai OSGeo Live baru
Pengiriman
- Wiki
Berikut ini yang menurut saya perlu dilakukan:
- Jalankan 50 Panduan Memulai OSGeo Live yang sudah ada
- Menandai dengan pengeditan. Kirim untuk ditinjau.
- Menerapkan ulasan/masukan
- Buat template Mulai Cepat untuk menerapkan konsistensi di masa mendatang.
- Perbarui 'Cara melakukan prosedur Mulai Cepat'.
- Menambahkan aplikasi baru ke OSGeoLive - aplikasi tersebut memerlukan Panduan Memulai.
Yang saya sarankan untuk dilakukan:
Tinjau 50 panduan Mulai Cepat OSGeo Live yang ada dan tandai dengan pengeditan - menggunakan halaman ini sebagai referensi:
Baru: https://trac.osgeo.org/osgeolive/wiki/How%20to%20document%20the%20quickstart%20file
Lama: https://wiki.osgeo.org/wiki/OSGeoLive_AddProject#Documentation
Membuat masalah dokumentasi di trac (Issue tracker)
Berikan laporan yang meringkas hasilnya. Misalnya, persentase dari 50 pekerjaan yang memerlukan sedikit, sedang, atau banyak.
Buat template Mulai Cepat untuk menerapkan konsistensi di masa mendatang.
Perbarui halaman 'Cara mendokumentasikan file Panduan memulai'.
Yang akan Anda miliki di akhir SoD:
- 50 tiket dokumentasi di trac, dengan Panduan Memulai yang ditandai sesuai template Panduan memulai yang telah disetujui
- Ringkasan status OSGeo Live Quickstarts saat ini dan jumlah pekerjaan yang diperlukan untuk mengupdatenya.
- Template Mulai Cepat yang diperbarui dan konsisten dengan template Panduan Pelatihan.
- Proses dokumentasi Panduan Memulai yang diperbarui.
Tempat saya akan memulai:
- Lihat spreadsheet Paket OSGeo-Live untuk melihat paket mana yang telah berubah di antara rilis.
- Tanyakan kepada milis OSGEo Live apakah mereka memiliki saran untuk Panduan Memulai tertentu.
Yang telah saya lakukan:
- Menyiapkan VM dan menginstal OSGeoLive
- Melakukan fork pada repo OSGeoLive-Doc
- Mendapatkan akses ke trac dan meninjau beberapa tiket dokumen yang ada. Tiket #1382 tampaknya relevan: https://trac.osgeo.org/osgeolive/ticket/1382
- Berpartisipasi dalam diskusi milis
- Melakukan beberapa chat video informal