Telliot: Преобразуйте документы в формат gitbook и создайте ежедневную задачу действий GH, чтобы скопировать все документы из репозитория майнера в главное репозиторий документов рассказчика.

Во-вторых, гораздо приятнее было бы хранить все документы в одной книге на github, а не заставлять людей переключаться между книгами, поэтому для этого мы должны:

• по-прежнему храните все документы, связанные с майнерами, здесь, в репозитории майнеров (проще синхронизировать документы с изменениями кода)
• создать ежедневную задачу cron действий GH, чтобы скопировать документы майнера отсюда в главное репозиторий документов рассказчика.

Я переименовываю название этой новой идеи.

Одно очень важное предостережение - сделать очень заметную заметку в основном репозитории документов рассказчика о том, что для изменений документации майнера PR должен быть открыт в репозитории майнера, а не в репозитории документов, поскольку в противном случае изменения будут перезаписаны из задачи ежедневной синхронизации.

это действие GH, кажется, нужно использовать
https://github.com/repo-sync/repo-sync

так что идея такова:

1. один PR для перемещения всех документов из https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation в это репо в папке /docs/miner-documentation .
2. Еще один PR, чтобы объединить документы из /docs/miner-documentation с существующими документами в /docs и преобразовать их в формат книги git.
3. Переместите корневые README.md и CHANGELOG.md в папку docs и просто оставьте ссылку, указывающую на gitbook.
4. Еще один PR для настройки repo-sync/repo-sync для синхронизации папки docs из этого репо в https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation
5. Еще один PR, чтобы добавить заметки, некоторые довольно заметные предупреждения никогда не редактировать https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation напрямую и вместо этого редактировать документы в этом репо, которые будут автоматически синхронизированы с основным репозиторием документов.

С помощью этого рабочего процесса будет довольно легко поддерживать документацию в актуальном состоянии, но при этом предоставить пользователю единый веб-сайт для чтения всего документа.

Это нужно сделать после или вместе с https://github.com/tellor-io/TellorMiner/issues/282.

Статус проблемы: 1. Открыт 2. Запущен 3. Отправлен 4. Готово

__Этот выпуск теперь имеет финансирование в размере 14,0 TRB (435,58 долларов США по 31,11 доллара США / TRB) .__

• Если вы хотите поработать над этой проблемой, вы можете «начать работу» на странице сведений о проблеме Gitcoin .
  
  
  
  • Хотите скинуться? Добавьте сюда свой вклад.
  
  
  • Вопросов? Оформить заказ Справка Gitcoin или чат Gitcoin
  
  
  • На 1 204 490,47 долларов больше профинансированных работ по OSS доступно в
  
  

Статус проблемы: 1. Открыт 2. Начато 3. Отправлено 4. Готово

__Работа начата__.

Каждый из этих пользователей утверждал, что может завершить работу к 265 годам, 12 месяцам.
Пожалуйста, ознакомьтесь с их планами действий ниже:

1) sebastiantf подал заявку на начало работы _ (Только спонсоры: одобрить работника | отклонить работника ) _.

Похоже на простую задачу с Github Actions. Я попробую сделать это
2) developerfred подал заявку на начало работы _ (только спонсоры: одобрить работника | отклонить работника ) _.

Я бы хотел сделать эту переносимость, у меня уже есть опыт работы с gitbook, и я недавно работал над проблемой Tellor golang
3) echolon166 подал заявку на начало работы _ (Только утвердить работника | отклонить работника ) _.

Я хотел бы помочь вам с этой задачей. Я буду следовать объяснениям, данным krasi-georgiev в этом выпуске, и конвертирую документы в формат gitbook и создаю задачу действий github, как вы хотели.
4) Manyrios подал заявку на начало работы _ (Только одобрить работника | отклонить работника ) _.

Выглядит очень интересно, хотелось бы попробовать
5) hhio618 одобрен к началу работы.

Хорошо, кажется простым. мы можем легко автоматически сгенерировать некоторые документы из кода, как это сделал Танос.

Узнайте больше на странице сведений о проблеме 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.

Привет @ krasi-georgiev. Вышеупомянутый PR (# 298) сделает это.
Также я проверил repo-sync/repo-sync out. Боюсь, это для синхронизации двух репозиториев с общей историей коммитов. Я отправлю еще один PR, чтобы решить проблему синхронизации папок, которая нам нужна здесь!

Спасибо, что вы думаете об автосинхронизации?

Я тестирую этот подход к действию GitHub прямо сейчас:
Каждые 1 час:
1. Клонировать https://github.com/tellor-io/telliot
2. Сравните папку TellorDocs/miner-documentation с telliot/docs используя хеши md5.
3. Если есть отличия, то -> обновить TellorDocs/miner-documentation
4. Отправьте изменения в репо TellorDocs

1. Отправка изменений в репозиторий TellorDocs

Вместо прямого толчка мы просто хотим, чтобы инструмент открывал PR, чтобы мы могли видеть изменения и вручную утвердить и объединить.

Между прочим, я только что вспомнил, что колледж сделал этот сценарий для аналогичной вещи, так что, возможно, вы сможете перенять часть логики оттуда.
https://github.com/prometheus/prometheus/blob/master/scripts/sync_repo_files.sh

Спасибо за советы. Я только что отправил еще один пиар .

Статус проблемы: 1. Открыт 2. Начато 3. Отправлено 4. Готово

__Работа на 14,0 TRB (361,72 USD @ 25,84 USD / TRB) предоставлена ​​__:

• Узнайте больше на странице сведений о проблеме Gitcoin.
• Хотите скинуться? Добавьте сюда свой вклад.
• Вопросов? Оформить заказ Справка Gitcoin или чат Gitcoin
• $ 1,197 918,50 на финансирование работ по OSS доступно в Gitcoin Issue Explorer

Теперь это сделано