matplotlib / matplotlib/ProjectManagement
Meeting Note Archival
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 3
- Forks
- 5
- Ø Merge
- 2 T. 14 Std.
- Gemergte PRs (30 T.)
- 6
Beschreibung
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:
- We continue to use hackmd for meetings.
- We make this repo the "truth" for archival purposes. Existing notes on hackmd can redirect to the corresponding location in this repository.
- 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.mdorto_import/meeting_notes.md. - We use a variation of the
tools/import_meeting_notes.pyscript to extract the meeting notes from the "incoming" path and automatically put them into the correspondingmeeting_notes/{year}/…mdfile. - The script keeps the latest X meetings for context (maybe 4 meetings) and saves them back to
to_import/meeting_notes.md. - 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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem Lesen von tools/import_meeting_notes.py und der Untersuchung der vorhandenen Dateien unter meeting_notes/{year}/. Verfolge, wie Notizen von einem eingehenden Pfad in das Archiv verschoben werden könnten, wobei aktuelle Meetings als Kontext erhalten bleiben. Als abgeschlossen gilt die Aufgabe, wenn der Archivierungsworkflow zuverlässig ist, durchsuchbare Notizen im Repository erzeugt und den vorgeschlagenen HackMD-Synchronisierungsprozess unterstützt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Aktiv
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100