###### tags: `work-log` `gsod` `docs`
# Google Season of Docs 2023
Project statement: https://github.com/matplotlib/matplotlib/wiki/Google-Season-of-Docs-2023:-Proposal
## Dev 15
- discussed opening up meeting next week
-
## Dec 12
- [x] [name=esibinga] writing email for event in spring
- [x] [name=hannah] working on tag directive body parsing
## Dec 1
- priority: directive supporting multiple lines
``` rst
.. tags::
a:1, a:2
```
- [name=hannah] spreadsheet ready to batch into PRs
- [name=esibinga] email CUNY GCDI about sprint
- [name=esibinga] edit case study down into blog post
- [name=hannah] create new news entry about GSOD
## Nov 20
- spreadsheet ready to be batched in
- staging: multiline sphinx tags then tag PRs
- GSOD case study due tomorrow
## Nov 10
- GSOD case study
- [name=melissawm] feedback on sphinx tags
- [name=esibinga] Eva todo list
## Nov 3
### wrap up
- potentially start up documentation working group/meetings
- put on call next week for biweekly/monthly meetings
- spreadsheet
- Eva will go through and validate the input ->
- afterwards Hannah will batch the PRs
- Eva will fixup glossary and open issue w/ rest of to dos
- maybe blog post debrief
- check in in week
- spreadsheet + next steps for feedback
## Oct 20
- reviewing spreadsheet for tagging sprint
- lock all columns but tagging + notes
- unfreeze notes once `tagged_by` is filled out
- add urls
- investigate getting hover over url to show thumbnail
- [name=hannah]potentially add iframe to sheet
- make sure the instructions are everywhere
- make title of column maybe `click Multiple Select Data Validation?`
- add column for proposed new tags
- nice to have: colors
- find out survailance tools for googles
- finish https://github.com/matplotlib/matplotlib/pull/26456
- [name=hannah] start a hackmd draft for the traffic control issue + share to folks
## Oct 13, 2023
- Melissa built sample
- Eva kept tagging things
## todo
- tracking spreadsheet for sprint
- github project for post sprint tracking
- report of tags
- precommit hook/ci hook for validating tags
## Oct 06, 2023
- going through tagging examples
-
## Notes for Sept 29, 2023
- updated draft PR with feedback
- [] continue to add tags to spreadsheet -- will share with [name=melissa] by 10/02 to create mock-up of tagged examples
- talked about creating a visual distinction of gallery example vs tutorial vs user guide (likely out of scope for this project)
## Notes for Sept 14, 2023
- discussed [Eva's draft](https://github.com/esibinga/matplotlib/blob/tag-guidelines/galleries/examples/tag_glossary.rst)
- potentially
## Notes for Sept 4, 2023
- possibly tagging a curated set for low bandwith?
- possibly: no-tag tag + id tag for identifying untagged
- using a potential pydata tagging-sprint as focusing/scoping for the 'how to tag' document
- continuing to do the tagging
- propose new tag in category or new category & explain why
- schedule: aim for 30% by oct 1st, 2nd draft of guidelines
### action items
- [x] [name=esibinga] open PR on matplotlib repo
## Notes for August 25th, 2023
- discussed tagging scope and scoping tags
- formatting using headings and sphinx design
- moving commit to new branch
- [x] [name=esibinga] formatting, flesh out why tags, scoping
- [x] [name=hannah] open issues on sphinx tag for glossary, formatting, and repetition
## Notes for August 18, 2023
- Tags _can_ follow the existing folder structure, but they don't have to.
- making progress on the busy work of tagging
- also on defining reference docs vs gallery example vs tutorial
### action items
- [x] [name=esibinga] more tagging + annotating - what tag means and why applied?
- [x] [name=esibinga] pull out first draft of tagging guidelines
- [x] [name=esibinga] post draft either on personal or mpl repo
- [x] [name=esibinga] status/schedule check
- [x] [name=hannah] fill out 3rd evaluation
## Notes for August 4, 2023
-
## Notes for July 28, 2023
- small and medium suggestions for cleaning up the gallery
### Action items
- [ ] [name=melissa, hannah] Figure out import of spreadsheet to google projects
## Notes for July 21, 2023
- Second monthly evaluation due July 25th, 2023 at 18:00 UTC
- about halfway through first pass tags
- continue building out tag guidelines
- down the line to do: add framing to the gallary
### Action items
- [ ] [name=melissa, hannah] Figure out import of spreadsheet to google projects
## Notes for July 14, 2023
- better defining what a gallary example is and a consistent format
- tags: folders?, `reference tag`
- format: teaches by demonstration, visual, so explanatory text at bottom
- put image before code
- reduce catagories for discoverability
- in gallary examples linking out to the user guide,
- specifically on reference page link out out to relevanty guides
- for more information
- at top of gallery page link out to guide + tutorials
- at meeting started a PR for adding a link out in anatomy
## Notes for June 28, 2023
- heirarchical tags
- top level gallery orgs - writing boilerplate scope for each section
- tried tagging tool, sticking w/ spreadsheet
- timeline:
- Aug 1: solid draft of comprehensive docs
- propose new tags
- rational new tags
- some differentiation between user guide/tutorial/examples
- After: additions would be more edge cases
## Notes for June 21, 2023
- [name=esibinga] created spreadsheet
- Add a few tags to each example manually initially (as a proof of concept)
- Links from zoom chat:
- https://git-scm.com/docs/git-grep
- https://nicolas.kruchten.com/content/2022/10/notascope-in-progress/
- https://www.robots.ox.ac.uk/~vgg/software/via/
- https://web.hypothes.is/education/
- [name=Melissa] First evaluation submitted
- [name=esibinga] First invoice sent
### Action items
- [ ] [name=melissa, hannah] Figure out import of spreadsheet to google projects
- [x] [name=esibinga] evaluate annotation tool for creating/storing tags/
- [x] [name=esibinga] timeline backward from guidelines deliverable
## Notes for June 14, 2023
- environment set up and docs build
- [x] [name=esibinga] get environment working
### Action items
- [x] [name=esibinga] post on incubator asking for help with system
- [x] [name=esibinga] start spreadsheet of docs
## Notes for June 6, 2023
- discussed rough timeline and prioritization
- sphinx-tagging mechanics
- mock up of how categories
- tags for retrieval vs discoverability
- turn auditing notes into a draft PR (either as reach deliverable or for someone to build on)
- went through setting up mpl dev environment (ran into mac build issues)
- demoed opening up a draft pr
### Action items
- [x] [name=esibinga] post on gitter/element about joining incubator
- [x] [name=esibinga] post on incubator asking for help with system
- [x] [name=esbinga] get environment working
- [x] [name=esibinga] start spreadsheet of docs
- [x] [name=hannah] check that github projects can import a spreadsheet
- kinda sorta requires api https://docs.github.com/en/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects#updating-projects
## Notes for May 24, 2023
**Present:** Eva, Teresa, Melissa, Hannah
- Weekly plans
- These meetings will be for information on the previous week's work and plans for next week
- Plan
- Explore and record entries in the gallery (as a spreadsheet)
- Gallery examples source code are here: https://github.com/matplotlib/matplotlib/tree/main/galleries/examples
- To see other examples scattered through the docs, grep for the plot directive (`.. plot::`)
- User guide/tutorial examples and gallery are separated because text and code were getting out of sync, and snippets from tutorials in the gallery may lack context.
- Idea: featured images for the gallery
- Gallery order: we have a custom sorter for each subsection of the gallery https://github.com/matplotlib/matplotlib/tree/main/doc/sphinxext
- Possible sorting keys: popularity, recently added, added on version X
- For next week: Melissa will demo how tagging works, and Eva will bring a mock up of how the gallery could look in the end. Teresa offers a usability review
- We will also use the gitter/matrix channel for async communication: https://app.gitter.im/#/room/#matplotlib_matplotlib:gitter.im
- Developer survey? Teresa might have some time in June to work on this
- Rough timeline
- November 6, 2023 - November 21, 2023 at 18:00 UTC is the final case study submission period
- 24 weeks total ("final day": Friday Nov 3rd)
- Proof-of-concept by the beginning of August
- Guidelines and implementation can be concurrent PRs, gathering feedback in parallel
### Action items
- [x] [name=Hannah] Verify if Eva has been added to the matplotlib org on GitHub
- [x] [name=Melissa] Follow through on NumFOCUS contract
- [x] [name=Hannah] Share results of previous developer/usability survey
- [x] [name=Eva] Explore gallery source code and docs configuration files
- [x] [name=Eva] List out project phases
- [x] [name=Eva] Mock up "final product" of project