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 摘要。