matplotlib / matplotlib/ProjectManagement

Meeting Note Archival

Ouverte
#11 5 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Python
Étoiles
3
Forks
5
Merge moyen
2 j 14 h
PR mergées (30 j)
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.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par lire tools/import_meeting_notes.py et examiner les fichiers existants dans meeting_notes/{year}/. Suivez la façon dont les notes pourraient passer d’un chemin d’entrée vers les archives tout en conservant les réunions récentes comme contexte. Le travail est considéré comme terminé lorsque le workflow d’archivage est fiable, produit des notes du dépôt consultables et prend en charge le processus de synchronisation HackMD proposé.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation, tooling
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
Active
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.