Telliot: ドキュメントをgitbook形式に変換し、GHアクションの毎日のタスクを作成して、すべてのドキュメントをマイナーリポジトリからメインテラードキュメントリポジトリにコピーします。

作成日 2020年11月12日  ·  13コメント  ·  ソース: tellor-io/telliot

現在、マイナーリポジトリにはdocsフォルダーの下にいくつかのドキュメントがあり、その他はhttps://github.com/tellor-io/TellorDocsのメインドキュメントリポジトリに保持されてい
これには2つの主な利点があります

  • 同じPRのコードに変更を加えると、ドキュメントも更新できます。
  • 2つのPRを開く必要がないため、同期を維持しやすくなります。
  • ドキュメントの一部は、コード自体から自動生成できます: https

問題をフォローする
この問題では、英語をしっかりと習得することが重要です。

good first issue help wanted .high clean up

全てのコメント13件

考え直してみると、ユーザーエクスペリエンスがはるかに優れているのは、すべてのドキュメントを1つのgithubブックに保持することであり、ユーザーをブック間でジャンプさせるのではなく、次のようにする必要があります。

  • マイナー関連のすべてのドキュメントをマイナーリポジトリに保持します(ドキュメントをコードの変更と同期させるのが簡単です)
  • 毎日のGHアクションcronタスクを作成して、マイナードキュメントをここからメインのテラードキュメントリポジトリにコピーします。

タイトルをこの新しいアイデアに変更します。

非常に重要な注意点の1つは、メインのテラードキュメントリポジトリに非常に目立つメモを配置することです。マイナードキュメントの変更の場合、PRはドキュメントリポジトリではなくマイナーリポジトリで開く必要があります。そうしないと、変更が毎日の同期タスクから上書きされます。

このGHアクションは使用するもののようです
https://github.com/repo-sync/repo-sync

つまり、アイデアは次のとおりです。

  1. すべてのドキュメントをhttps://github.com/tellor-io/TellorDocs/tree/master/miner-documentationから/docs/miner-documentationフォルダー内のこのリポジトリに移動する1つのPR。
  2. /docs/miner-documentationドキュメントを/docsの既存のドキュメントとマージし、それらをgitbook形式に変換する別のPR。
  3. ルートのREADME.mdとCHANGELOG.mdをdocsフォルダーに移動し、gitbookを指すリンクを残します。
  4. repo-sync/repo-syncをセットアップしてdocsフォルダーをこのリポジトリからhttps://github.com/tellor-io/TellorDocs/tree/master/miner-documentationに同期する別のPR
  5. https://github.com/tellor-io/TellorDocs/tree/master/miner-documentation直接編集せず、代わりにメインのドキュメントリポジトリと自動同期されるこのリポジトリのドキュメントを編集しないように、いくつかの非常に目に見える警告を追加する別のPR。

このワークフローを使用すると、ドキュメントを最新の状態に保つのは非常に簡単ですが、ドキュメント全体を読むための単一のWebサイトをユーザーに提供します。

これは、 https://github.com/tellor-io/TellorMiner/issues/282の後で、または一緒に行う必要があり

問題のステータス:1。オープン2.開始3.送信済み4.完了


__この号には、14.0 TRB(435.58 USD @ $ 31.11 / TRB)の資金が添付されています。__

問題のステータス:1。オープン2.開始3.送信済み4.完了


__作業が開始されました__。

これらのユーザーはそれぞれ、今から12か月後の265年までに作業を完了することができると主張しました。
以下の彼らの行動計画を確認してください:

1) sebastiantfが作業の開始を申請しました_(ファンダーのみ:ワーカーの承認|ワーカーの拒否)_。

GithubActionsを使用した簡単なタスクのようです。 これをやってみよう
2) developerfredが作業の開始を申請しました_(ファンダーのみ:ワーカーの承認|ワーカーの拒否)_。

私はこの移植性を実現したいと思っています。私はすでにgitbookの経験があり、最近、テラーのGolangの問題に取り組みました。
3) echolon166が作業の開始に適用されました_(ファンダーのみ:ワーカーの承認|ワーカーの拒否)_。

この作業をお手伝いしたいと思います。 この号のkrasi-georgievの説明に従い、ドキュメントをgitbook形式に変換して、必要に応じてgithubアクションタスクを作成します。
4) manyriosが作業の開始を申請しました_(ファンダーのみ:ワーカーの承認|ワーカーの拒否)_。

とても面白そうです試してみたいです
5) hhio618は作業開始が承認されました。

わかりました、簡単そうです。 Thanosが行ったように、コードからいくつかのドキュメントを簡単に自動生成できます。

詳細については、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をチェックアウトしました。 これは、2つのリポジトリを共有コミット履歴と同期するためのものです。 ここで必要なフォルダ同期に対処するために、別のPRを送信します。

ありがとう、自動同期について何を考えていますか?

私は今、このGitHubアクションアプローチをテストしています:
1時間ごと:
1.クローンhttps://github.com/tellor-io/telliot
2. md5ハッシュを使用して、 TellorDocs/miner-documentationフォルダーをtelliot/docsと比較します。
3.違いがある場合は、-> TellorDocs/miner-documentation更新します
4.変更をTellorDocsリポジトリにプッシュします

  1. 変更をTellorDocsリポジトリにプッシュする

直接プッシュする代わりに、ツールでPRを開いて変更を確認し、手動で承認してマージする必要があります。

ところで、私はちょうど大学が同様のことのためにこのスクリプトを行ったことを思い出したので、おそらくそこからロジックのいくつかを採用することができます。
https://github.com/prometheus/prometheus/blob/master/scripts/sync_repo_files.sh

ヒントをありがとう。 別のPRを提出しました。

問題のステータス:1。オープン2.開始3.送信済み4.完了


__ 14.0 TRB(361.72 USD @ $ 25.84 / TRB)の作業は__によって提出されました:


これで完了です

このページは役に立ちましたか?
0 / 5 - 0 評価