matplotlib / matplotlib/ProjectManagement

Meeting Note Archival

未關閉
#11 5 則留言 1 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

主要語言
Python
星號
3
分支
5
平均合併
2 天 14 小時
30 天內合併 PR
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.

貢獻指南

這個儲存庫沒有索引到貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

先閱讀 tools/import_meeting_notes.py,並檢查現有的 meeting_notes/{year}/ 檔案。追蹤如何將筆記從傳入路徑移至封存區,同時保留最近的會議作為內容背景。完成的標準是封存工作流程可靠、能產生可搜尋的 repository 筆記,並支援提議的 HackMD 同步流程。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
python
領域
documentation, tooling
Issue 類型
功能
難度
5/5
預估耗時
一週以上
活躍度
活躍
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。