matplotlib / matplotlib/ProjectManagement
Meeting Note Archival
まだ誰も着手していません。
- 主要言語
- Python
- スター
- 3
- フォーク
- 5
- 平均マージ
- 2日 14時間
- マージ済み PR(30日)
- 6
説明
I'm writing this up as an issue so everybody can opine.
Right now, we use hackmd for meeting notes.
It's great for collaborative editing, but it's not the best from an archival perspective. Features such as full-text search and unlimited history are locked behind membership plans.
As a new member to the team, I struggled to find information covered in old meetings. I also struggled with **immense** browser slowdown and crashes when viewing/editing meeting notes (I thought it was my computer until Hannah mentioned that others experience it).
I was also confused as to the canonical location for archived notes, as they appeared on both hackmd and this repository.
I'd like the propose the following:
1. We continue to use hackmd for meetings.
2. We make this repo the "truth" for archival purposes. Existing notes on hackmd can redirect to the corresponding location in this repository.
3. We use the "Push to GitHub" feature each month to save the current meeting notes to GitHub. Incoming meeting notes would be saved to a specific path, like `incoming/meeting_notes.md` or `to_import/meeting_notes.md`.
4. We use a variation of the `tools/import_meeting_notes.py` script to extract the meeting notes from the "incoming" path and automatically put them into the corresponding `meeting_notes/{year}/…md` file.
5. The script keeps the latest X meetings for context (maybe 4 meetings) and saves them back to `to_import/meeting_notes.md`.
6. The trimmed file can be synced to hackmd via "Pull from GitHub". (Alternatively, we can manually trim the file on the hackmd side - whatever is easier).
Once we get steps 3 and 4 working reliably, it should be possible to either fully automate or at least automatically open up a PR for review.
We could also use the same approach for New Contributors Meetings notes and GSOC meeting notes.
Ideally, I'd like to make it as easy as possible to archive meeting notes so they get saved in searchable form more often.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず tools/import_meeting_notes.py を読み、既存の meeting_notes/{year}/ ファイルを調べます。最近のミーティングをコンテキストとして保持しながら、ノートを入力パスからアーカイブへ移動できる方法を追跡します。アーカイブワークフローが信頼でき、検索可能なリポジトリノートを生成し、提案された HackMD 同期プロセスをサポートできれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation, tooling
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 活発
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100