Sebelum Anda memulai
- Izin untuk mengekspor konten kelompok terkait dan informasi pribadi.
- Dokumentasi untuk aplikasi sumber, format ekspor, dan tujuan yang dimaksud.
- Tujuan uji terpisah dengan notifikasi keluar dan integrasi eksternal yang dibatasi.
1. Tentukan apa yang harus memungkinkan paket itu lakukan.
Tuliskan hasil yang diinginkan sebelum memilih tombol ekspor. Salinan yang dapat dibaca untuk anggota yang keluar, pemindahan ke aplikasi lain, dan pemulihan penuh layanan yang ada memerlukan materi yang berbeda. Satu ekspor mungkin melayani tujuan pertama dengan baik dan gagal pada dua tujuan lainnya.
BookStack membuat perbedaan ini secara eksplisit: alat ekspor dan impor kontennya tidak dimaksudkan sebagai pencadangan dan pemulihan. Salinan HTML atau PDF yang dapat dibaca memang berguna, tetapi tidak boleh secara diam-diam menggantikan kumpulan pemulihan untuk aplikasi tersebut. BookStack mengekspor dan mengimpor konten.
Untuk kelompok lokakarya hipotetis, tujuan awalnya sederhana: pemelihara resmi lain dapat membaca buku panduan operasional dan mengimpor bagian perwakilan, termasuk diagramnya, ke dalam instans uji terpisah.
2. Catat format dan celahnya.
Buat matriks yang menjelaskan apa yang perlu Anda pertahankan dan bagaimana Anda akan membuktikannya. Jangan menulis “selesai” di sebuah sel sampai Anda memeriksa tujuan.
| Materi | Keluaran kandidat | Pertanyaan yang harus diselesaikan |
|---|---|---|
| Halaman wiki | HTML yang dapat dibaca plus paket impor yang didukung | Apakah judul, tautan, dan diagram dipertahankan? |
| Lampiran | File asli dan manifes | Dapatkah setiap referensi penting menemukan filenya? |
| Kalender | File pertukaran kalender yang didukung | Apakah perulangan dan zona waktu berperilaku seperti yang diharapkan? |
| Keanggotaan dan izin | Catatan pemetaan peran terkendali | Aturan akses mana yang perlu dibuat ulang secara manual? |
| Pemulihan aplikasi | Kumpulan pencadangan spesifik versi | Konfigurasi dan basis data apa yang masih diperlukan? |
BookStack mendokumentasikan format ZIP portabel yang berisi data konten, lampiran, dan gambar yang dapat diimpor kembali ke BookStack. Itu tidak menetapkan kompatibilitas dengan wiki lain atau pelestarian setiap pengaturan tingkat layanan. Format ekspor BookStack.
3. Berikan titik awal yang manusiawi pada paket.
Tambahkan readme singkat berisi aplikasi sumber dan versi, tanggal dan zona waktu ekspor, cakupan yang dipilih, peran pengekspor, daftar file, dan tujuan yang diharapkan. Gunakan nama folder yang deskriptif seperti readable-content, attachments dan import-package. Simpan kredensial di tempat lain; tulis hanya prosedur pengambilan yang disetujui untuk pemelihara resmi.
Buku panduan hipotetis berisi daftar periksa pembuka, halaman perawatan mesin, diagram, dan satu lembar kerja tertaut. Manifesnya mencatat keempat item tersebut, jalur relatifnya, dan hubungan antara halaman dan lampirannya. Catat juga halaman terbatas sebagai sengaja dikecualikan, agar ketidakhadirannya tidak nanti disalahartikan sebagai kehilangan yang tidak disengaja.
Checksum dapat membantu mengidentifikasi file yang tidak berubah selama transfer. Itu tidak membuktikan bahwa ekspor sudah lengkap, izinnya benar, atau dapat dibaca.
4. Periksa sampel yang representatif.
Buka salinan yang dapat dibaca tanpa mengandalkan sesi aktif di aplikasi asli. Ikuti tautan, periksa gambar yang disematkan, dan buka lampiran yang tertaut. Cari referensi yang masih mengarah kembali ke layanan sumber. Catat tautan mana yang sengaja eksternal dan mana yang akan rusak setelah pemindahan.
Untuk kalender, pilih sampel yang mencakup acara berulang, pengecualian, dan acara dengan zona waktu yang relevan. Nextcloud mendokumentasikan ekspor kalender dan iCalendar yang kompatibel untuk .ics impor. Itu menetapkan jalur pertukaran yang didukung, bukan bukti bahwa target Anda mempertahankan setiap fitur yang dipilih. Impor dan ekspor Kalender Nextcloud.
Periksa dokumentasi untuk rilis yang terpasang sebelum mengikuti label antarmuka; manual bergulir yang tertaut mungkin menjelaskan versi yang berbeda.
5. Impor ke tujuan terpisah yang terkendali.
Gunakan tujuan uji yang kosong atau koleksi uji yang secara eksplisit disetujui. Biarkan layanan kerja dan data aslinya tidak tersentuh. Nonaktifkan notifikasi keluar dan batasi koneksi eksternal sebelum memulai aplikasi hasil impor; tujuannya adalah menilai data, bukan mengirim ulang acara historis ke anggota.
Minta pemelihara kedua mengikuti readme tanpa mengandalkan instruksi yang tidak terdokumentasi dari pengekspor. Bandingkan item yang diharapkan dengan hasil impor. Verifikasi diagram, tautan lembar kerja, struktur halaman, dan izin anggota yang dimaksudkan. Catat setiap pemetaan peran yang memerlukan pekerjaan manual. Jika suatu format tidak memiliki fitur yang diperlukan, putuskan apakah akan merekonstruksinya, memilih metode ekspor lain, atau menyimpan arsip yang dapat dibaca bersama layanan baru.
6. Buat kegagalan menjadi informatif.
Jika file hilang, bandingkan cakupan ekspor dan izin pengekspor sebelum berulang kali menghasilkan arsip yang lebih besar. Jika tautan rusak, tentukan apakah tautan merujuk ke layanan lama atau file yang tidak ada dalam paket. Jika impor membuat duplikat yang tidak terduga, hentikan dan periksa aturan pencocokannya sebelum mengimpor paket yang sama lagi.
Untuk contoh lokakarya, penerimaan berarti pemelihara kedua dapat membaca dan mengedit halaman yang dipilih, mengambil setiap file yang disertakan, dan menunjukkan bahwa anggota biasa tidak dapat mengakses materi yang dikecualikan. Catat setiap hasil dan peninjau-nya. “Impor selesai” hanyalah satu pengamatan. Simpan perbedaan yang belum terselesaikan bersama paket agar kelompok dapat membuat keputusan yang disengaja tentangnya.
7. Pisahkan ekspor dan pemulihan dalam jalurnya masing-masing.
Simpan paket yang diterima di lokasi terkendali yang independen dari layanan sumber dan sepakati kapan harus menyegarkannya. Tinjau kembali setelah ada perubahan pada format, izin, atau versi aplikasi yang penting. File ekspor dapat berisi konten pribadi meskipun tujuannya hanya sementara, jadi tetapkan juga akses dan keputusan retensi untuknya.
Simpan kumpulan pemulihan aplikasi secara terpisah: dokumentasi pemulihan BookStack, misalnya, memerlukan materi basis data dan file di luar ekspor dokumen yang dapat dibaca. Persyaratan pencadangan dan pemulihan BookStack.
Lanjutkan dengan latihan pemulihan untuk pemulihan layanan, lembar kerja penyimpanan untuk ruang kerja ekspor dan inventaris layanan untuk dependensi. Portabilitas adalah sesuatu yang harus dibuktikan dengan paket Anda, bukan diasumsikan dari ekstensi file.
Dokumentasi di balik catatan ini
Gunakan dokumentasi untuk versi yang benar-benar Anda jalankan. Contoh-contoh ini adalah materi perencanaan, bukan catatan pengujian pada VPS Hoszen.