matplotlib / matplotlib/ProjectManagement

Meeting Note Archival

Đang mở
#11 5 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
Python
Star
3
Fork
5
Merge trung bình
2 ngày 14 giờ
Pull request đã merge (30 ngày)
6

Mô tả

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.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu bằng cách đọc tools/import_meeting_notes.py và kiểm tra các tệp meeting_notes/{year}/ hiện có. Theo dõi cách các ghi chú có thể được chuyển từ một đường dẫn đầu vào vào kho lưu trữ, đồng thời giữ lại các cuộc họp gần đây để làm ngữ cảnh. Hoàn thành khi quy trình lưu trữ đáng tin cậy, tạo ra các ghi chú trong repository có thể tìm kiếm và hỗ trợ quy trình đồng bộ HackMD được đề xuất.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
documentation, tooling
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Sôi nổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
45/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.