matplotlib / matplotlib/ProjectManagement

Meeting Note Archival

Aberta
#11 5 comentários 1 reação 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
Python
Estrelas
3
Forks
5
Merge médio
2d 14h
PRs com merge (30d)
6

Descrição

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.

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece lendo tools/import_meeting_notes.py e inspecionando os arquivos existentes em meeting_notes/{year}/. Rastreie como as notas poderiam passar de um caminho de entrada para o arquivo, mantendo as reuniões recentes como contexto. A tarefa estará concluída quando o fluxo de arquivamento for confiável, produzir notas pesquisáveis no repositório e der suporte ao processo de sincronização proposto do HackMD.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
python
Domínio
documentation, tooling
Tipo de issue
Funcionalidade
Dificuldade
5/5
Tempo estimado
Mais de uma semana
Status de atividade
Ativa
Clareza
Razoavelmente clara
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.