Telliot: Konvertieren Sie die Dokumente in das Gitbook-Format und erstellen Sie eine tägliche Aufgabe für GH-Aktionen, um alle Dokumente aus dem Miner-Repository in das Haupt-Teller-Dokumenten-Repository zu kopieren.

Erstellt am 12. Nov. 2020  ·  13Kommentare  ·  Quelle: tellor-io/telliot

Im Moment hat das Miner-Repo einige Dokumente im Ordner docs und andere werden im Hauptdokument-Repo unter https://github.com/tellor-io/TellorDocs aufbewahrt. Ich denke, das Hauptdokumentationsrepo sollte Dokumente zum Projekt selbst enthalten und eine Übersicht über alle Komponenten und Miner-spezifische Dokumente (wie man baut, wie man sie ausführt usw.) sollte hier im Miner-Repository aufbewahrt werden. Das Hauptdokument-Repository enthält dann nur einen Link zu den Github-Buchdokumenten der Miner.
Dies hat 2 Hauptvorteile

  • Wenn wir Änderungen am Code in derselben PR vornehmen, können auch die Dokumente aktualisiert werden.
  • einfacher zu synchronisieren, da keine 2 PRs geöffnet werden müssen.
  • Einige Teile der Dokumente können automatisch aus dem Code selbst generiert werden: https://github.com/tellor-io/TellorMiner/issues/194

Folgen Sie dem Thema
Für dieses Thema sind solide Englischkenntnisse wichtig

good first issue help wanted .high clean up

Alle 13 Kommentare

Bei einem zweiten Gedanken wäre eine viel angenehmere Benutzererfahrung, alle Dokumente in einem einzigen Github-Buch zu speichern, anstatt die Leute dazu zu bringen, zwischen Büchern hin und her zu springen. Um dies zu erreichen, sollten wir:

  • Bewahren Sie weiterhin alle Miner-bezogenen Dokumente hier im Miner-Repository auf (einfacher, die Dokumente mit den Codeänderungen synchron zu halten)
  • Erstellen Sie eine tägliche Cron-Aufgabe für GH-Aktionen, um die Miner-Dokumente von hier in das Haupt-Teller-Dokumenten-Repository zu kopieren.

Ich benenne den Titel in diese neue Idee um.

Eine sehr wichtige Einschränkung besteht darin, im Haupt-Teller-Dokumenten-Repository einen gut sichtbaren Hinweis darauf zu setzen, dass für Änderungen an Miner-Dokumenten ein PR im Miner-Repository und nicht im Docs-Repository geöffnet sein sollte, da sonst die Änderungen aus der täglichen Synchronisierungsaufgabe überschrieben werden.

diese GH-Aktion scheint die richtige zu sein
https://github.com/repo-sync/repo-sync

also die idee ist:

  1. ein PR, um alle Dokumente von https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation in dieses Repository im Ordner /docs/miner-documentation .
  2. Ein weiterer PR, um die Dokumente aus /docs/miner-documentation mit den vorhandenen Dokumenten in /docs und in das Git-Book-Format zu konvertieren.
  3. Verschieben Sie die Root-README.md und CHANGELOG.md in den docs-Ordner und hinterlassen Sie einfach einen Link, der auf das Gitbook verweist.
  4. Ein weiterer PR zum Einrichten von repo-sync/repo-sync zum Synchronisieren des docs Ordners aus diesem Repository in https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation
  5. Ein weiterer PR, der einige gut sichtbare Warnungen hinzufügt, um https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation niemals direkt zu bearbeiten und stattdessen die Dokumente in diesem Repository zu bearbeiten, die automatisch mit dem Hauptdokument-Repository synchronisiert werden.

Mit diesem Workflow ist es recht einfach, die Dokumente auf dem neuesten Stand zu halten, dem Benutzer aber dennoch eine einzige Website zum Lesen des gesamten Dokuments bereitzustellen.

Dies muss nach oder zusammen mit https://github.com/tellor-io/TellorMiner/issues/282 . erfolgen

Problemstatus: 1. Offen 2. Gestartet 3. Gesendet 4. Fertig


__Diese Ausgabe ist jetzt mit 14,0 TRB (435,58 USD @ 31,11 USD/TRB) verbunden.__

Problemstatus: 1. Offen 2. Gestartet 3. Gesendet 4. Fertig


__Arbeit wurde begonnen__.

Diese Benutzer gaben jeweils an, dass sie die Arbeit in 265 Jahren, also in 12 Monaten, abschließen können.
Bitte überprüfen Sie ihre Aktionspläne unten:

1) sebastiantf hat einen Antrag auf Aufnahme der Arbeit gestellt _(nur Geldgeber: Arbeiter genehmigen | Arbeiter ablehnen )_.

Scheint mit Github Actions eine einfache Aufgabe zu sein. Ich werde es versuchen
2) Developerfred hat einen Antrag auf Arbeitsaufnahme gestellt _(nur Geldgeber: Arbeiter genehmigen | Arbeiter ablehnen )_.

Ich würde diese Portabilität gerne machen, ich habe bereits Erfahrung mit gitbook und habe kürzlich an einem Tellor-Golang-Problem gearbeitet
3) echolon166 hat einen Antrag auf Arbeitsaufnahme gestellt _(Nur Arbeiter genehmigen | Arbeiter ablehnen )_.

Bei dieser Aufgabe möchte ich Sie gerne unterstützen. Ich werde der Erklärung von krasi-georgiev in der Ausgabe folgen, die Dokumente in das Gitbook-Format konvertieren und die Github-Aktionsaufgabe nach Ihren Wünschen erstellen.
4) Manyrios hat einen Antrag auf Aufnahme der Arbeit gestellt _(nur Arbeiter genehmigen | Arbeiter ablehnen )_.

Sieht sehr interessant aus würde ich gerne ausprobieren
5) hhio618 wurde zur Arbeitsaufnahme

Okay, scheint einfach. Wir können ganz einfach automatisch einige Dokumente aus dem Code generieren, wie es Thanos getan hat.

Weitere Informationen finden Sie

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.

Hallo @krasi-georgiev. Der obige PR (#298) wird dies tun.
Außerdem habe ich repo-sync/repo-sync ausgecheckt. Ich fürchte, das ist für die Synchronisierung von zwei Repositorys mit gemeinsamen Commit-Verläufen. Ich werde eine weitere PR einreichen, um die Ordnersynchronisierung anzugehen, die wir hier benötigen!

Danke, was hast du für die automatische Synchronisierung im Sinn?

Ich teste gerade diesen GitHub-Aktionsansatz:
Alle 1 Stunde:
1. Klonen von https://github.com/tellor-io/telliot
2. Vergleichen Sie den Ordner TellorDocs/miner-documentation mit telliot/docs Verwendung von md5-Hashes.
3. Wenn es Unterschiede gibt, dann -> aktualisiere TellorDocs/miner-documentation
4. Push-Änderungen in TellorDocs Repo

  1. Push-Änderungen an TellorDocs-Repository

Anstelle eines direkten Pushs möchten wir nur, dass das Tool eine PR öffnet, damit wir die Änderungen sehen und manuell genehmigen und zusammenführen.

Übrigens habe ich mich gerade daran erinnert, dass ein College dieses Skript für eine ähnliche Sache erstellt hat, damit Sie vielleicht etwas von der Logik von dort übernehmen können.
https://github.com/prometheus/prometheus/blob/master/scripts/sync_repo_files.sh

Danke für die Tipps. Ich habe gerade eine weitere PR eingereicht.

Problemstatus: 1. Offen 2. Gestartet 3. Gesendet 4. Fertig


__Arbeit für 14,0 TRB (361,72 USD @ 25,84 USD/TRB) wurde eingereicht von__:


Das ist jetzt erledigt

War diese Seite hilfreich?
0 / 5 - 0 Bewertungen