Telliot: Convierta los documentos en formato gitbook y cree una tarea diaria de acciones de GH para copiar todos los documentos del repositorio de mineros en el repositorio principal de documentos de tellor.

Creado en 12 nov. 2020  ·  13Comentarios  ·  Fuente: tellor-io/telliot

Por el momento, el repositorio minero tiene algunos documentos en la carpeta docs y otros se guardan en el repositorio principal de documentos en https://github.com/tellor-io/TellorDocs. Creo que el repositorio de documentos principal debe mantener los documentos relacionados con el proyecto en sí y una descripción general de todos los componentes y documentos específicos del minero (cómo construir, cómo ejecutar, etc.) debe mantenerse aquí en el repositorio del minero. El repositorio de documentos principal solo tendrá un enlace a los documentos del libro de github de mineros.
Esto tiene 2 beneficios principales

  • cuando hacemos cambios al código en el mismo PR también podemos actualizar los documentos.
  • más fácil de mantener sincronizado, ya que no será necesario abrir 2 RP.
  • algunas partes de los documentos se pueden generar automáticamente a partir del propio código: https://github.com/tellor-io/TellorMiner/issues/194

Sigue el problema
Un dominio sólido del idioma inglés es importante para este problema.

good first issue help wanted .high clean up

Todos 13 comentarios

Pensándolo bien, una experiencia de usuario mucho mejor sería mantener todos los documentos en un solo libro de github en lugar de hacer que la gente salte entre libros, por lo que para lograr esto deberíamos:

  • aún mantenga todos los documentos relacionados con los mineros aquí en el repositorio de mineros (es más fácil mantener los documentos sincronizados con los cambios de código)
  • cree una tarea cron diaria de acciones de GH para copiar los documentos del minero desde aquí al repositorio principal de documentos de tellor.

Cambiaré el nombre del título a esta nueva idea.

Una advertencia muy importante es poner una nota muy visible en el repositorio principal de tellor docs de que para los cambios de documentos de mineros, un PR debe estar abierto en el repositorio de mineros y no en el repositorio de documentos, de lo contrario, los cambios se sobrescribirán desde la tarea de sincronización diaria.

esta acción de GH parece ser la que se debe usar
https://github.com/repo-sync/repo-sync

entonces la idea es:

  1. un PR para mover todos los documentos de https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation a este repositorio en la carpeta /docs/miner-documentation .
  2. Otro RP para fusionar los documentos de /docs/miner-documentation con los documentos existentes en /docs y convertirlos al formato de libro git.
  3. Mueva la raíz README.md y CHANGELOG.md a la carpeta docs y simplemente deje un enlace que apunte al gitbook.
  4. Otro RP para configurar repo-sync/repo-sync para sincronizar la carpeta docs de este repositorio en https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation
  5. Otro RP para agregar notas algunas advertencias bastante visibles para nunca editar https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation directamente y editar los documentos en este repositorio en su lugar, que se sincronizará automáticamente con el repositorio principal de documentos.

Con este flujo de trabajo, será bastante fácil mantener los documentos actualizados, pero seguir proporcionando un único sitio web para que el usuario lea el documento completo.

Esto debe hacerse después o junto con https://github.com/tellor-io/TellorMiner/issues/282

Estado del problema: 1. Abierto 2. Iniciado 3. Enviado 4. Listo


__Este número ahora tiene un financiamiento de 14.0 TRB (435.58 USD @ $ 31.11 / TRB) adjunto .__

Estado del problema: 1. Abierto 2. Iniciado 3. Enviado 4. Listo


__Se ha iniciado el trabajo__.

Cada uno de estos usuarios afirmó que puede completar el trabajo en 265 años, 12 meses a partir de ahora.
Revise sus planes de acción a continuación:

1) sebastiantf ha solicitado comenzar a trabajar _ (solo para financiadores: aprobar trabajador | rechazar trabajador ) _.

Parece una tarea sencilla con Github Actions. Intentaré hacer esto
2) developerfred ha solicitado comenzar a trabajar _ (solo para financiadores: aprobar trabajador | rechazar trabajador ) _.

Me encantaría hacer esta portabilidad, ya tengo experiencia con gitbook y recientemente trabajé en un problema de tellor golang
3) echolon166 ha solicitado comenzar a trabajar _ (solo para financiadores: aprobar trabajador | rechazar trabajador ) _.

Me gustaría ayudarlo con esta tarea. Seguiré la explicación dada por krasi-georgiev en el número, convertiré los documentos en formato gitbook y crearé la tarea de acciones de github como desee.
4) Manyrios ha solicitado comenzar a trabajar _ (solo para financiadores: aprobar trabajador | rechazar trabajador ) _.

Parece muy interesante, me gustaría probarlo.
5) hhio618 ha sido aprobado para comenzar a trabajar.

Ok, parece sencillo. podemos generar automáticamente algunos documentos a partir del código, como hizo Thanos.

Obtenga más información en la página de detalles del problema de 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.

Hola @ krasi-georgiev. El PR anterior (# 298) hará esto.
Además, revisé repo-sync/repo-sync . Me temo que es para sincronizar dos repositorios con historiales de confirmaciones compartidos. Enviaré otro RP para abordar la sincronización de carpetas que necesitamos aquí.

Gracias, ¿qué tienes en mente para la sincronización automática?

Estoy probando este enfoque de acción de GitHub en este momento:
Cada 1 hora:
1. Clonar https://github.com/tellor-io/telliot
2. Compare la carpeta TellorDocs/miner-documentation con telliot/docs usando hashes md5.
3. Si hay alguna diferencia, entonces -> actualice TellorDocs/miner-documentation
4. Envíe los cambios al repositorio de TellorDocs

  1. Impulsar cambios en el repositorio de TellorDocs

En lugar de un impulso directo, solo queremos que la herramienta abra un PR para que podamos ver los cambios y aprobar y fusionar manualmente.

por cierto, acabo de recordar que una universidad hizo este guión para algo similar, así que tal vez puedas adoptar algo de la lógica a partir de ahí.
https://github.com/prometheus/prometheus/blob/master/scripts/sync_repo_files.sh

Gracias por los consejos. Acabo de enviar otro PR .

Estado del problema: 1. Abierto 2. Iniciado 3. Enviado 4. Listo


__Trabajo para 14.0 TRB (361.72 USD @ $ 25.84 / TRB) ha sido enviado por__:


Esto ya esta hecho

¿Fue útil esta página
0 / 5 - 0 calificaciones