Dokumentasi Quire

Panduan untuk semua orang yang menggunakan Quire, dan rujukan untuk semua orang yang membina di atasnya. Pilih panduan bagi kerja yang anda lakukan.

Mula dengan peranan anda, kemudian ikuti panduan topik untuk tugas yang berada di hadapan anda. Pembangun boleh menggunakan rujukan API penuh dalam Bahasa Inggeris bersama-sama dengan mana-mana versi bahasa panduan ini. Pengendali sepatutnya bermula dengan buku panduan pemasangan dan memastikan panduan sandaran dan naik taraf sentiasa tersedia sebelum membuat sebarang perubahan.

• Pentadbir

  Menetapkan organisasi: orang, peranan, log masuk, jenama, bahasa, e-mel dan rekod

• Guru

  Membina kursus, menulis halaman bersama-sama, menetapkan dan menanda kerja

• Pelajar

  Mencari kursus, belajar luar talian, dan menjadikan Quire selesa untuk dibaca

• Pembangun

  REST API, OAuth, webhook dan pelayan MCP

• Rujukan API

  Setiap titik akhir dan peristiwa webhook, dijana daripada dokumen OpenAPI

• Pengendali

  Memasang, menaik taraf, membuat sandaran dan mengkitar kunci pada Quire kendiri

Topik pentadbiran dan pengajaran

• Tetapan organisasi

  Alamat, bahasa lalai, suis dan peranan bergred

• Pelan dan penbilangan

  Apa yang setiap pelan sertakan, penggunaan, menukar pelan, tambahan berasaskan ukuran

• Perkongsian antara organisasi

  Ruang dikongsi, dan bagaimana kursus dikongsi berjalan dalam cermin

• Sambungan

  Apa yang terbina dalam, dan cara menghidupkannya atau mematikannya

• Pembekal sesi langsung dan video

  Akaun BigBlueButton, Zoom, Teams, Meet, Jitsi, Cloudflare Stream, Mux atau Bunny anda sendiri

• Ciri AI

  Pembekal, ciri, dasar, belanjawan dan siapa yang membaca perbualan tutor

• Dasar dan penggunaan wajar

  Dasar penerbitan, penerimaan, dan penguatkuasaan penggunaan wajar

• Bank kandungan

  Menggunakan semula fail dan kandungan interaktif merentas kursus

Panduan integrasi

• n8n

  Aliran kerja n8n, dengan nod komuniti Quire

• Zapier

  Zapier, melalui webhook dan REST API

• Make

  Senario Make, melalui webhook dan REST API

• HubSpot

  HubSpot contacts, companies, workflows dan rekod hubungan

• LTI 1.3

  Alat pembelajaran luaran, dan H5P

• Log masuk tunggal

  Pembekal identiti anda melalui OpenID Connect atau SAML, dan penyediaan SCIM

Konvensyen dalam panduan ini

• Laluan seperti /admin/users ialah halaman pada alamat organisasi anda, contohnya https://acme.quirelms.com/admin/users.
• Apa yang anda boleh lihat bergantung pada peranan anda. Jika sebuah halaman dalam panduan tiada untuk anda, pentadbir anda belum memberikan peranan anda keizinan itu.
• Quire tidak pernah memadam sesuatu tanpa memberitahu apa yang akan berlaku terlebih dahulu. Di mana sesuatu panduan menyatakan “buang”, jangkakan satu pengesahan yang menyebut akibatnya.