Telliot: Ubah dokumen menjadi format gitbook dan buat tugas harian tindakan GH untuk menyalin semua dokumen dari repo penambang ke repo dokumen tellor utama.

Dibuat pada 12 Nov 2020  ·  13Komentar  ·  Sumber: tellor-io/telliot

Saat ini repo penambang memiliki beberapa dokumen di bawah folder docs dan yang lainnya disimpan di repo dokumen utama di https://github.com/tellor-io/TellorDocs. Saya pikir repo dokumen utama harus menyimpan dokumen yang terkait dengan proyek itu sendiri dan ikhtisar semua komponen dan dokumen khusus penambang (cara membangun, cara menjalankan dll) harus disimpan di sini di repo penambang. Repo dokumen utama kemudian hanya akan memiliki tautan ke dokumen buku github penambang.
Ini memiliki 2 manfaat utama

  • ketika kita melakukan perubahan kode di PR yang sama juga dapat memperbarui dokumen.
  • lebih mudah untuk tetap sinkron karena tidak perlu membuka 2 PR.
  • beberapa bagian dokumen dapat dibuat secara otomatis dari kode itu sendiri: https://github.com/tellor-io/TellorMiner/issues/194

Ikuti isunya
Perintah yang kuat dari bahasa Inggris penting untuk masalah ini

good first issue help wanted .high clean up

Semua 13 komentar

Setelah dipikir-pikir, pengalaman pengguna yang jauh lebih baik adalah menyimpan semua dokumen dalam satu buku github daripada membuat orang melompat-lompat di antara buku-buku sehingga untuk mencapai ini kita harus:

  • masih menyimpan semua dokumen terkait penambang di sini di repo penambang (lebih mudah untuk menyinkronkan dokumen dengan perubahan kode)
  • buat tugas cron tindakan GH harian untuk menyalin dokumen penambang dari sini ke repo dokumen tellor utama.

Saya mengganti nama judul untuk ide baru ini.

Satu peringatan yang sangat penting adalah untuk menempatkan catatan yang sangat terlihat di repo dokumen tellor utama bahwa untuk perubahan dokumen penambang, PR harus dibuka di repo penambang dan bukan di repo dokumen karena jika tidak, perubahan akan ditimpa dari tugas sinkronisasi harian.

tindakan GH ini tampaknya yang digunakan
https://github.com/repo-sync/repo-sync

jadi idenya adalah:

  1. satu PR untuk memindahkan semua dokumen dari https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation ke repo ini di folder /docs/miner-documentation .
  2. PR lain untuk menggabungkan dokumen dari /docs/miner-documentation dengan dokumen yang ada di /docs dan mengonversinya ke dalam format buku git.
  3. Pindahkan root README.md dan CHANGELOG.md ke dalam folder docs dan tinggalkan tautan yang mengarah ke gitbook.
  4. PR lain untuk mengatur repo-sync/repo-sync untuk menyinkronkan folder docs dari repo ini ke https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation
  5. PR lain untuk menambahkan catatan beberapa peringatan yang cukup terlihat untuk tidak pernah mengedit https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation secara langsung dan mengedit dokumen dalam repo ini sebagai gantinya yang akan disinkronkan secara otomatis dengan repo dokumen utama.

Dengan alur kerja ini, akan sangat mudah untuk memperbarui dokumen, tetapi tetap menyediakan satu situs web kepada pengguna untuk membaca seluruh dokumen.

Ini perlu dilakukan setelah atau bersama-sama dengan https://github.com/tellor-io/TellorMiner/issues/282

Status Masalah: 1. Buka 2. Mulai 3. Dikirim 4. Selesai


__Masalah ini sekarang memiliki dana sebesar 14,0 TRB (435,58 USD @ $31,11/TRB) yang menyertainya.__

Status Masalah: 1. Buka 2. Mulai 3. Dikirim 4. Selesai


__Pekerjaan telah dimulai__.

Pengguna ini masing-masing mengklaim bahwa mereka dapat menyelesaikan pekerjaan dalam 265 tahun, 12 bulan dari sekarang.
Silakan tinjau rencana aksi mereka di bawah ini:

1) sebastiantf telah melamar untuk mulai bekerja _(Hanya penyandang dana: menyetujui pekerja | menolak pekerja )_.

Sepertinya tugas langsung dengan Github Actions. Saya akan mencoba melakukan ini
2) developerfred telah melamar untuk mulai bekerja _(Hanya penyandang dana: menyetujui pekerja | menolak pekerja )_.

Saya ingin melakukan portabilitas ini, saya sudah memiliki pengalaman dengan gitbook dan saya baru-baru ini mengerjakan masalah teller golang
3) echolon166 telah melamar untuk mulai bekerja _(Hanya menyetujui pekerja | menolak pekerja )_.

Saya ingin membantu Anda dengan tugas ini. Saya akan mengikuti penjelasan yang diberikan oleh krasi-georgiev dalam masalah ini, dan akan mengubah dokumen menjadi format gitbook & membuat tugas tindakan github seperti yang Anda inginkan.
4) manyrios telah melamar untuk mulai bekerja _(Hanya menyetujui pekerja | menolak pekerja )_.

Sepertinya sangat menarik saya ingin mencobanya try
5) hhio618 telah disetujui untuk mulai bekerja.

Oke, sepertinya langsung. kita dapat dengan mudah membuat beberapa dokumen secara otomatis dari kode seperti yang dilakukan Thanos.

Pelajari lebih lanjut di halaman Detail Masalah Gitcoin .

1. one PR to move all docs from `https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation` to this repo in the `/docs/miner-documentation` folder.

2. Another PR to merge the docs from `/docs/miner-documentation` with the existing docs in `/docs` and convert them into the git book format.

Hai @krasi-georgiev. PR(#298) di atas akan melakukan ini.
Juga, saya memeriksa repo-sync/repo-sync . Saya khawatir itu untuk menyinkronkan dua repositori dengan riwayat komit bersama. Saya akan mengirimkan PR lain untuk mengatasi sinkronisasi folder yang kami butuhkan di sini!

Terima kasih, apa yang Anda pikirkan untuk sinkronisasi otomatis?

Saya sedang menguji pendekatan tindakan GitHub ini sekarang:
Setiap 1 jam:
1. Klon https://github.com/tellor-io/telliot
2. Bandingkan folder TellorDocs/miner-documentation dengan telliot/docs menggunakan hash md5.
3. Jika ada perbedaan maka -> perbarui TellorDocs/miner-documentation
4. Dorong perubahan ke TellorDocs repo

  1. Dorong perubahan ke repo TellorDocs

Alih-alih dorongan langsung, kami hanya ingin alat membuka PR sehingga kami dapat melihat perubahan dan akan menyetujui dan menggabungkan secara manual.

btw saya baru ingat bahwa sebuah perguruan tinggi melakukan skrip ini untuk hal serupa jadi mungkin Anda bisa mengadopsi beberapa logika dari sana.
https://github.com/prometheus/prometheus/blob/master/scripts/sync_repo_files.sh

Terima kasih untuk tipsnya. Saya baru saja mengirimkan PR lain.

Status Masalah: 1. Buka 2. Mulai 3. Dikirim 4. Selesai


__Pekerjaan untuk 14.0 TRB (361.72 USD @ $25.84/TRB) telah dikirimkan oleh__:


Ini sekarang sudah selesai

Apakah halaman ini membantu?
0 / 5 - 0 peringkat