matplotlib / matplotlib/ProjectManagement
Meeting Note Archival
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3
- Forks
- 5
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 6
Description
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.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading tools/import_meeting_notes.py and inspecting the existing meeting_notes/{year}/ files. Trace how notes could move from an incoming path into the archive while retaining recent meetings for context. Done means the archival workflow is reliable, produces searchable repository notes, and supports the proposed HackMD synchronization process.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100