Telliot: Convertissez les documents au format gitbook et créez une tùche quotidienne d'actions GH pour copier tous les documents du dépÎt mineur dans le dépÎt principal de documents Tellor.

CrĂ©Ă© le 12 nov. 2020  Â·  13Commentaires  Â·  Source: tellor-io/telliot

Pour le moment, le rĂ©fĂ©rentiel du mineur contient des documents dans le dossier docs et d'autres sont conservĂ©s dans le rĂ©fĂ©rentiel de documents principal Ă  l' adresse https://github.com/tellor-io/TellorDocs. Je pense que le rĂ©fĂ©rentiel de documents principal doit conserver les documents liĂ©s au projet lui-mĂȘme et un aperçu de tous les composants et documents spĂ©cifiques au mineur (comment construire, comment exĂ©cuter, etc.) doit ĂȘtre conservĂ© ici dans le rĂ©fĂ©rentiel du mineur. Le rĂ©fĂ©rentiel de documents principal n'aura alors qu'un lien vers les documents du livre github des mineurs.
Cela a 2 avantages principaux

  • lorsque nous apportons des modifications au code dans le mĂȘme PR peut Ă©galement mettre Ă  jour les documents.
  • plus facile Ă  synchroniser puisqu'il n'y aura pas besoin d'ouvrir 2 PR.
  • certaines parties de la documentation peuvent ĂȘtre gĂ©nĂ©rĂ©es automatiquement Ă  partir du code lui-mĂȘme : https://github.com/tellor-io/TellorMiner/issues/194

Suivez le problĂšme
Une solide maĂźtrise de la langue anglaise est importante pour ce problĂšme

good first issue help wanted .high clean up

Tous les 13 commentaires

À la rĂ©flexion, une expĂ©rience utilisateur beaucoup plus agrĂ©able serait de conserver tous les documents dans un seul livre github plutĂŽt que de faire sauter les gens entre les livres. Pour y parvenir, nous devrions :

  • conservez toujours tous les documents liĂ©s aux mineurs ici dans le rĂ©fĂ©rentiel du mineur (il est plus facile de synchroniser les documents avec les modifications du code)
  • crĂ©ez une tĂąche cron quotidienne d'actions GH pour copier les documents du mineur d'ici vers le rĂ©fĂ©rentiel principal de documents tellor.

Je renomme le titre de cette nouvelle idée.

Une mise en garde trĂšs importante est de mettre une note trĂšs visible dans le rĂ©fĂ©rentiel de documents principal Tellor que pour les modifications de documents de mineur, un PR doit ĂȘtre ouvert dans le rĂ©fĂ©rentiel de mineur et non dans le rĂ©fĂ©rentiel de documents, sinon les modifications seront Ă©crasĂ©es Ă  partir de la tĂąche de synchronisation quotidienne.

cette action GH semble ĂȘtre celle Ă  utiliser
https://github.com/repo-sync/repo-sync

donc l'idée est :

  1. un PR pour déplacer tous les documents de https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation vers ce référentiel dans le dossier /docs/miner-documentation .
  2. Un autre PR pour fusionner les documents de /docs/miner-documentation avec les documents existants dans /docs et les convertir au format git book.
  3. DĂ©placez la racine README.md et CHANGELOG.md dans le dossier docs et laissez simplement un lien pointant vers le gitbook.
  4. Un autre PR pour configurer repo-sync/repo-sync pour synchroniser le dossier docs de ce référentiel dans https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation
  5. Un autre PR pour ajouter des notes d'avertissements assez visibles pour ne jamais éditer https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation directement et éditer les documents de ce référentiel à la place, qui seront automatiquement synchronisés avec le référentiel de documents principal.

Avec ce flux de travail, il sera assez facile de maintenir les documents à jour, tout en fournissant un seul site Web à l'utilisateur pour lire l'intégralité du document.

Cela doit ĂȘtre fait aprĂšs ou avec https://github.com/tellor-io/TellorMiner/issues/282

État du problĂšme : 1. Ouvert 2. CommencĂ© 3. Soumis 4. TerminĂ©


__Ce numéro a maintenant un financement de 14,0 TRB (435,58 USD @ 31,11 $/TRB) qui lui est attaché.__

État du problĂšme : 1. Ouvert 2. CommencĂ© 3. Soumis 4. TerminĂ©


__Les travaux ont commencé__.

Ces utilisateurs ont chacun affirmé qu'ils pouvaient terminer le travail d'ici 265 ans, dans 12 mois.
Veuillez consulter leurs plans d'action ci-dessous :

1) sebastiantf a postulé pour commencer le travail _(Bailleurs de fonds uniquement : approuver le travailleur | rejeter le travailleur )_.

Cela semble ĂȘtre une tĂąche simple avec Github Actions. je vais essayer de faire ça
2) developerfred a postulé pour commencer le travail _(Bailleurs de fonds uniquement : approuver le travailleur | rejeter le travailleur )_.

J'adorerais faire cette portabilité, j'ai déjà de l'expérience avec gitbook et j'ai récemment travaillé sur un problÚme tellor golang
3) echolon166 a demandé à commencer le travail _(Bailleurs de fonds uniquement : approuver le travailleur | rejeter le travailleur )_.

Je voudrais vous aider dans cette tùche. Je suivrai l'explication donnée par le krasi-georgiev dans le numéro, et je convertirai les documents au format gitbook et créerai la tùche d'actions github comme vous le souhaitez.
4) manyrios a postulé pour commencer le travail _(Bailleurs de fonds uniquement : approuver le travailleur | rejeter le travailleur )_.

ça a l'air trÚs intéressant j'aimerais l'essayer
5) hhio618 a été approuvé pour commencer le travail.

Ok, ça semble simple. nous pouvons facilement générer automatiquement des documents à partir du code comme ce que Thanos a fait.

En savoir plus sur la page DĂ©tails du problĂšme 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.

Salut @krasi-georgiev. Le PR ci-dessus (#298) le fera.
De plus, j'ai vérifié repo-sync/repo-sync . J'ai bien peur que ce soit pour synchroniser deux référentiels avec des historiques de commit partagés. Je vais soumettre un autre PR pour traiter la synchronisation des dossiers dont nous avons besoin ici !

Merci, qu'avez-vous en tĂȘte pour la synchronisation automatique ?

Je teste cette approche d'action GitHub en ce moment :
Toutes les 1 heure :
1. Cloner https://github.com/tellor-io/telliot
2. Comparez le dossier TellorDocs/miner-documentation avec telliot/docs utilisant les hachages md5.
3. S'il y a des différences -> mettre TellorDocs/miner-documentation jour
4. Pousser les modifications vers le dépÎt TellorDocs

  1. Pousser les modifications vers le référentiel TellorDocs

Au lieu d'une poussée directe, nous voulons simplement que l'outil ouvre un PR afin que nous puissions voir les changements et approuver et fusionner manuellement.

d'ailleurs, je viens de me rappeler qu'un collĂšge a fait ce script pour une chose similaire, alors peut-ĂȘtre que vous pouvez adopter une partie de la logique Ă  partir de lĂ .
https://github.com/prometheus/prometheus/blob/master/scripts/sync_repo_files.sh

Merci pour les conseils. Je viens de soumettre un autre PR .

État du problĂšme : 1. Ouvert 2. CommencĂ© 3. Soumis 4. TerminĂ©


__Le travail pour 14,0 TRB (361,72 USD à 25,84 $/TRB) a été soumis par__ :


C'est maintenant fait

Cette page vous a été utile?
0 / 5 - 0 notes

Questions connexes

krasi-georgiev picture krasi-georgiev  Â·  15Commentaires

krasi-georgiev picture krasi-georgiev  Â·  9Commentaires

bramp picture bramp  Â·  3Commentaires

leebrooks0 picture leebrooks0  Â·  3Commentaires

satb picture satb  Â·  3Commentaires