Alt text - napari documentation

An event for napari documentation!

Intro

Wednesday, March 30 (check the time in your timezone)

and

Thursday, March 31 (check the time in your timezone)

Welcome! Thank you for taking the time to learn a few ways to make open source—or any digital space—more accessible.

We are all learning, so please don't hesitate to ask questions.

Agenda

• 0 minutes-35: Welcome, sprint goal and image description infomation
• 35–105: Work time!
• 105–120: Review alt text and open question time

Resources

Needed for the event:

• The collaborative event PR
• Step by Step Images: How to Add Alt-text with Github Suggestions
• napari documentation
• napari glossary
• Slides

Extra information:

• W3's Alt decision tree (What kind of alt text does this image need?)
• WebAim's overview of alt text (What is alt text and what does it need to do?)
• Diagram Center's standards for alt text for graphs and charts (How do I describe images with a lot of data?)
• Alt text style guide for Jupyter accessibility workshops

How to participate

1. Go to our working PR and review the list of files needing alt text.
2. Comment on the PR which file you plan to work on. You can work as a team if desired!
3. Write alt text for an image.
4. Submit that alt text on the PR via a single-comment suggestion. Step by Step Images: How to Add Alt-text with Github Suggestions.

Note: If there is an image you want to add alt text to that is not yet in the PR, tell Isabela and she can add it.

6. Repeat steps 2 through 4 as much as you'd like. Be sure to coordinate with others to cover as much of the blog as we can.
7. Optional: If you have time, you can team up with other participants and give feedback on each others' alt text.
8. You did it! Great work!

Alt text review checklist

These are a few of the main things we need to make sure are met for formatting consistent alt text.

The alt text has

• Correct spelling and no typos
• Periods and commas where relevant
• No more than three short, complete sentences
• A logical way of fitting in the rest of the documentation
• Consistent text and/or descriptions for the same elements in different images
• A description of any text in the image

Hall of Fame ✨

Submission style

Let's celebrate the hard work of sprint participants by showcasing the best alt text authored during the event!

To add an image description you admire, please include:

• Author's name via Github handle (please use @)
• The alt text you are submitting (copied over)
• A link to where the alt text suggestion was made

Thank you for helping us give recognition to people participating and providing great alt text examples for people to reference in the future!

Submissions

Questions

We'll try and answer questions during the event, but often people have questions that will require a little research or we just plain run out of time. Feel free to leave questions so we can get back to them post-event.

• [Your questions here! Adding your name is optional.]