Publikasikan artikel ke ReadMe
Hubungkan proyek ReadMe dengan Kunci API-nya dan publikasikan artikel Clevera sebagai Panduan dalam kategori yang kamu pilih, dengan tangkapan layar yang diunggah ke ReadMe. Cara callout, langkah-langkah, dan video dikonversi, cara kerja pembaruan, dan kesalahan umum.
Publikasikan artikel Clevera sebagai panduan di proyek ReadMe kamu, yang disimpan di bawah kategori panduan yang kamu pilih. Tangkapan layar diunggah ke ReadMe.
Sebelum kamu mulai
- Di Clevera: ruang kerja menggunakan paket Pro atau Kustom, dan kamu adalah pemilik atau admin untuk menghubungkan ReadMe. Setelah tersambung, siapa pun yang dapat mengedit artikel dapat mempublikasikannya. Lihat Publikasikan artikel ke alat kamu yang lain.
- Di ReadMe: proyek yang dapat kamu kelola, dengan setidaknya satu kategori di bagian Panduan-nya. Satu kunci menghubungkan satu proyek.
- Proyek ReadMe saat ini: Clevera mempublikasikan melalui API (v2) ReadMe saat ini, yang ditawarkan ReadMe untuk proyek di ReadMe Refactored. Proyek yang masih menggunakan platform lama ReadMe tidak dapat dihubungkan.
- Versi: Clevera mempublikasikan ke versi utama (stabil) Panduan proyek kamu.
- Artikel: buat artikelnya terlebih dahulu. Publikasi hanya mengirimkan artikel. Untuk menyertakan video, tempatkan di dalam artikel; lihat Tampilkan video dalam artikel.
Temukan Kunci API ReadMe kamu
Di proyek ReadMe kamu, buka Configuration → API Keys, lalu salin kunci (buat satu jika daftar kosong). Kunci ini memberikan akses penuh ke proyek tersebut, jadi jagalah kerahasiaannya.
Hubungkan ReadMe
Buka jendela hubungkan
Di Clevera, klik nama ruang kerja kamu di bilah sisi, pilih Integrasi, temukan ReadMe, dan klik Hubungkan. Jendela Hubungkan ReadMe akan menampilkan "Tempel kunci. Kami akan memeriksanya sebelum menyimpan apa pun."
Tempel dan periksa kunci
Tempel kunci ke dalam Kunci API dan klik Periksa kunci. Saat ReadMe menerimanya, kamu akan melihat "Kunci diterima." dan proyek kamu di bawah Situs untuk dipublikasikan.
Hubungkan
Klik Hubungkan. Kamu akan melihat "ReadMe tersambung." dan ReadMe muncul di bawah Tersambung dengan nama proyek kamu.
Kunci tidak kedaluwarsa di sisi Clevera. Untuk menghubungkan proyek yang berbeda, gunakan Hubungkan kembali pada koneksi ReadMe dan tempel kunci proyek tersebut; ini akan menggantikan kunci yang lama.
Publikasikan artikel ke ReadMe
Buka tab Publikasikan
Di editor, klik Bagikan → Publikasikan dan klik ubin ReadMe di bawah Siap untuk dipublikasikan.
Pilih kategori panduan
Di bawah Tempat tujuan, Proyek menampilkan proyek yang terhubung. Pilih Kategori panduan: "Artikel akan masuk ke bagian Panduan, di bawah kategori ini." Jika kamu melihat "Belum ada kategori panduan", buatlah satu di ReadMe terlebih dahulu.
Publikasikan
Klik Publikasikan ke ReadMe. Clevera akan mencari salinan yang ada terlebih dahulu; jika panduan dengan alamat yang sama sudah ada, pilih tindakan yang akan dilakukan (lihat Perbarui panduan). Setelah selesai, kamu akan melihat "Dipublikasikan ke ReadMe." Klik Buka di ReadMe untuk melihat panduan tersebut.
Kamu dapat menutup jendela Bagikan saat proses berlangsung; notifikasi akan memberi tahu kamu saat proses selesai.
Alamat panduan berasal dari judulnya: "Set up billing" menjadi /docs/set-up-billing di situs dokumentasi kamu. Judul dalam skrip lain atau dengan aksen akan dieja dalam huruf Latin terlebih dahulu. Jika alamat sudah digunakan, ReadMe akan memberikan alamat yang sedikit berbeda untuk panduan baru tersebut.
Seperti apa tampilan panduan di ReadMe
Judul panduan adalah judul artikel. Panduan hanya berisi artikel: video asal artikel tersebut tidak ditambahkan.
| Di Clevera | Di ReadMe |
|---|---|
| Judul, paragraf | Judul dan teks |
| Tebal, miring, coret, kode inline, tautan | Dipertahankan. Tautan ke halaman Clevera lain hanya mempertahankan teksnya. |
| Sorotan, superskrip, subskrip | Dipertahankan |
| Daftar poin dan bernomor, daftar periksa | Daftar dan daftar periksa |
| Kutipan | Kutipan |
| Blok kode | Blok kode dengan bahasa dan judul kode |
| Pemisah | Pemisah |
| Tabel | Tabel dengan teks dari setiap sel |
| Callout | Callout ReadMe dengan judul callout: 📘 untuk info dan catatan, 👍 untuk tips dan sukses, 🚧 untuk peringatan, ❗️ untuk bahaya |
| Langkah bernomor | Daftar bernomor: judul setiap langkah ditebalkan, kontennya bersarang di bawahnya |
| Tab | Label setiap tab ditebalkan, diikuti oleh kontennya. Tab yang hanya berisi kode menjadi tab kode ReadMe. |
| Bagian yang dapat diciutkan | Bagian yang dapat diperluas |
| Kartu | Daftar tautan dengan deskripsinya; ikon kartu tidak disertakan |
| Persamaan | Kode |
| Tangkapan layar | Gambar yang diunggah ke ReadMe, dengan keterangan dalam huruf miring |
| Video dan sematan dalam artikel | Sematan ReadMe. Video Clevera disertakan hanya jika tautan bagikan video tersebut aktif. |
Kurung kurawal dan kurung sudut dalam teks kamu akan di-escape, sehingga format halaman ReadMe menampilkannya sebagaimana ditulis.
Tangkapan layar diunggah ke ReadMe, sehingga tetap berfungsi meskipun kamu menghapus artikel di Clevera. Tangkapan layar yang gagal diunggah, atau file video di dalam artikel, akan tetap menjadi tautan ke Clevera yang kedaluwarsa setelah beberapa saat; publikasikan kembali untuk memperbaruinya.
Perbarui panduan
Publikasi hanya berjalan satu arah. Panduan tidak diperbarui saat kamu mengedit artikel di Clevera, dan editan yang dibuat di ReadMe tidak akan pernah kembali ke Clevera. Setelah kamu mengedit artikel, publikasikan kembali.
Clevera mencari panduan dengan alamat yang sama di mana pun dalam Panduan kamu dan menampilkan "Artikel ini sudah ada di ReadMe." Klik Lihat untuk membukanya, lalu pilih:
- Perbarui artikel yang ada akan menimpa panduan tersebut: alamat sama, judul dan konten baru. Klik Perbarui di ReadMe.
- Buat artikel baru akan membuat panduan baru di bawah Judul baru yang kamu masukkan, dengan alamatnya sendiri. Klik Buat artikel baru.
Perubahan yang dibuat di ReadMe sejak publikasi terakhir akan ditimpa saat Clevera memperbarui panduan.
Putuskan sambungan dan cabut akses
- Di Clevera, buka Integrasi, klik ReadMe, lalu Putuskan sambungan dan konfirmasi. Panduan yang sudah kamu publikasikan tetap ada di ReadMe.
- Di ReadMe, buka Configuration → API Keys dan hapus kunci yang kamu berikan ke Clevera.
Pemecahan masalah
| Kamu melihat | Apa yang harus dilakukan |
|---|---|
| "Tempel kunci terlebih dahulu." | Bidang kunci kosong. |
| "Kunci API tidak valid. Harap periksa Kunci API ReadMe kamu." | Kunci salah atau telah dihapus. Salin kembali dari Configuration → API Keys. |
| "Gagal mengambil info proyek dari ReadMe." atau "Kami tidak dapat memeriksa kunci itu. Coba lagi." | ReadMe tidak merespons, atau proyek tidak ada di ReadMe Refactored, yang diperlukan Clevera. Coba lagi, lalu coba kunci baru; jika proyek ada di platform lama ReadMe, proyek tersebut tidak dapat dihubungkan. |
| "Tidak dapat memvalidasi Kunci API. Harap periksa Kunci API ReadMe kamu." atau "Gagal terhubung ke ReadMe. Harap periksa Kunci API kamu." | Periksa kunci dan hubungkan kembali. |
| "Belum ada kategori panduan" / "Buat kategori panduan di ReadMe untuk mempublikasikan di sini." | Tambahkan kategori ke Panduan kamu di ReadMe, lalu buka kembali tab Publikasikan. |
| "Pilih kategori terlebih dahulu." atau "Pilih kategori ReadMe untuk mempublikasikan panduan ini." | Pilih kategori panduan sebelum mempublikasikan. |
| "Kamu dapat melihat item ini tetapi tidak dapat mempublikasikannya. Minta seseorang yang dapat mengeditnya." | Kamu memerlukan akses edit ke artikel untuk mempublikasikannya. |
| "Kunci API tidak ditemukan. Harap hubungkan kembali ReadMe." | Hubungkan kembali ReadMe dengan kunci. |
| "Konten artikel kosong atau tidak valid." | Artikel belum memiliki konten. Buka, periksa, lalu publikasikan. |
| "Tidak dapat mempublikasikan ke ReadMe" dengan pesan dari ReadMe, seperti pesan tentang slug atau kategori | ReadMe menolak panduan tersebut. Periksa apakah kategori masih ada, atau ganti nama artikel dan klik Coba lagi. |
| "Gagal memperbarui panduan di ReadMe" | Panduan yang coba kamu perbarui telah dihapus atau diganti namanya di ReadMe. Publikasikan kembali dan pilih Buat artikel baru. |
| "Gagal mempublikasikan ke ReadMe. Harap coba lagi." | Klik Coba lagi. Jika masih gagal, hubungkan kembali dengan kunci baru. |