owned this note
owned this note
Published
Linked with GitHub
---
tags: NumPy
---
# 2024-07-15 NumPy Documentation Team meeting
- Time: 7 pm UTC
- Join via Zoom: https://numfocus-org.zoom.us/j/85016474448?pwd=TWEvaWJ1SklyVEpwNXUrcHV1YmFJQT09 (To dial in, find your local number: https://numfocus-org.zoom.us/u/kbRSNdYfoZ)
- [NumPy community events calendar](https://scientific-python.org/calendars/)
- [Documentation issues](https://github.com/numpy/numpy/labels/04%20-%20Documentation)
- [Documentation brainstorming document](https://hackmd.io/RdtnQZpLRZqgNRe4gaJ0SA) - anything that is not yet ready for an issue or PR or needs a discussion
- [Documentation team meetings notes archive](https://github.com/numpy/archive/tree/main/docs_team_meetings)
- [Community meetings notes archive](https://github.com/numpy/archive/tree/main/community_meetings)
- [Triage meetings notes archive](https://github.com/numpy/archive/tree/master/triage_meetings)
- Next meeting: 2024-07-29 @ 7 pm UTC
### Useful links
- Getting started with building documentation: https://numpy.org/devdocs/dev/howto_build_docs.html
- How to contribute to the NumPy documentation: https://numpy.org/devdocs/dev/howto-docs.html
### Code of Conduct
We want to take a moment to remind you that this meeting is meant to be welcoming and inclusive. It's important for us to have a healthy community. Like all NumPy spaces, and everyone participating in them, this meeting will follow our [Code of Conduct](https://numpy.org/code-of-conduct/). If you haven't read it yet, please take some time to do so later on as it already applies to you. For now, in short, please be kind and generous towards one another.
If you see violations, take a screenshot, intervene in a respectful manner, and report it to the CoC Committee via email. For more information, refer to the Reporting Guidelines section on https://numpy.org/code-of-conduct/.
**Present:** Mukulika, Mars, Anne Gunn, Ben Woodruff, Kakaire Steven, Luiz Amaral
**Notes taken by:**
## Standing topics
- [name=inessa] Presentation topics for NumPy Newcomers’ Hour
To suggest a topic for future presentations, leave a comment in this tracking issue: https://github.com/numpy/archive/issues/58.
- Short form content?
- [name=Inessa & Melissa] [Documentation user stories](https://github.com/numpy/numpy/issues/22089)
*Feel free to add yours!*
- Inessa: issues related to the NumPy educational content:
https://github.com/numpy/archive/issues/55
If you’d like to work on any of them, leave a comment on GitHub (below the relevant issue).
- Tracking inactive PRs: https://github.com/orgs/numpy/projects/6
(help with triaging is welcome!)
## Follow-up from last meeting / discussions
- GSOD 2024 Updates: Completing the ["How to Contribute to NumPy" comics](https://heyzine.com/flip-book/3e66a13901.html):
- July 15: working on page 16, 17
- [Link to page 16](https://github.com/MarsBarLee/gsod-numpy-2023/blob/main/pg%2016.png?raw=true)
- [Link to page 17](https://github.com/MarsBarLee/gsod-numpy-2023/blob/main/pg%2017.png?raw=true)
- Later this week, submit the pages with illustration to Mukulika
- July 1: nearly done with page 14, 15
- [Link to page 14](https://github.com/MarsBarLee/gsod-numpy-2023/blob/main/pg%2014%2007-01-2024.png?raw=true)
- PR is based on the real NPR filetype: https://github.com/numpy/numpy/pull/23357
- [Link to page 15](https://github.com/MarsBarLee/gsod-numpy-2023/blob/main/pg%2015%2007-01-2024.png?raw=true)
- Update character details, map
- June 16: nearly done with page 12 and page 13
- [Link to page 12](https://github.com/MarsBarLee/gsod-numpy-2023/blob/main/pg_12_06_17_2024.png?raw=true)
- [Link to page 13](https://github.com/MarsBarLee/gsod-numpy-2023/blob/main/pg_13_06_17_2024.png?raw=true)
- Next steps
- July timeline: page 16, 17
- August: 18/credits/cover, finish up illustration of page 12, 13, 14, 15 to ready to Community Review #3
- September: Community Review #3
- Focus right now is getting outline illustration, come back to details before review
- Typo on page 13, typo "I'm (to) happy that a contributor", remove the word 'to'
- July 13, community meeting Kakarire Steven is hosting, send out physical comic
- Can do a quick review before the September community review
- Send printing settings to Kakaire
- Previous updates:
- [Script from last two pages, where it gets busy](https://docs.google.com/document/d/1fjLTDqSkcKMxo8oSTRThllBFpjo5rXS9/edit#bookmark=id.4d34og8)
- Does not include credits: perhaps text instead of illustration of short on time.
- Comments on overview: happy how translated scrpit to visuals, accruate. Like how story ties together, leave with tips on how to interact with open source communities
- POV changes, from PR maker to maintainer, humanize process
- Collaborate with future editions of NumPy Community Survey on effectiveness of comics
- Talk at PyConUS about comic went well!
- Talk title: Paint by Numbers: A Retrospective on the NumPy Comics (and Under-Represented Skillsets in Documentation)
- At the Documentation Summit, a track that helped bring people in a big conference
- Setback: Oops, comic script has been deleted. It was hosted on an old work account
- Backup of older versions found on Github repo
- Workaround: sketches have up-to-date dialogue, just a little hard to read sometimes
- Mukulika will do a rough review of the remaining pages
- [DOC: add cheat sheet](https://github.com/numpy/numpy/issues/26593)
- Inspirations: [Pandas](https://github.com/pandas-dev/pandas/blob/main/doc/cheatsheet/Pandas_Cheat_Sheet.pdf), [Matplotlib](https://matplotlib.org/cheatsheets/), [Xarray](https://docs.xarray.dev/en/stable/howdoi.html)
- Difficult to encompass the entire software
- Subdivide into different modules we want cheat sheets for
- Categories based on concepts or features
- Duplication not a concern as such; different way of representing info
- NumPy cheatsheets will be good for SEOs. Some already available online. See if we can adapt them.
- Link to POSSEE: https://github.com/possee-org/genai-numpy/issues/94
- Is there a review comparing existing cheatsheets? Are others too long, disorganized, etc?
- Are there artifacts or documentation that will be left behind?
- [DOC: Change hardlinked NEPs to intersphinx mappings](https://github.com/numpy/numpy/issues/26707) - PR submitted by Anne: https://github.com/numpy/numpy/pull/26808
- Kakaire starting a new community with weekly meetings. Looking to bring in speakers.
- New tutorial idea by Anne: Application of broadcasting in image processing - explanation of the concept
- Possible references:
- https://github.com/rougier/from-python-to-numpy
- https://librehub.github.io/napari-LatAm-workshop-2023/day1/3_python_introduction/05b_images_are_numpy_arrays.html
- Also maybe https://github.com/elegant-scipy/elegant-scipy
## New topics
- Draft PR for cheatsheets: https://github.com/possee-org/genai-numpy/pull/122
- Useful to point out features in existing cheatsheets that are not desirable
- Generated cheatsheet: https://github.com/possee-org/genai-numpy/tree/main/numpy-cheatsheet
- Mukulika to see where the discussion moves forward
- What function does add_newdocs.py(something similar) serve? Examples in `ma` module.
### Let's connect and keep the conversation going!
Join the NumPy contributor community **Slack workspace**: https://join.slack.com/t/numpy-team/shared_invite/zt-1gokbq56s-bvEpo10Ef7aHbVtVFeZv2w
Sign up to the NumPy **mailing list**: mail.python.org/mailman/listinfo/numpy-discussion
Subscribe to the NumPy **YouTube** channel: https://www.youtube.com/c/NumPy_team
Follow us on **Twitter**: [@numpy_team](https://twitter.com/numpy_team)
Follow us on **LinkedIn**: https://www.linkedin.com/company/numpy/
---
Remember to archive this file by committing it to
[https://github.com/numpy/archive/tree/main/docs_team_meetings](https://github.com/numpy/archive/tree/main/docs_team_meetings)