Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BLOG] Add Making pygments accessible #527

Merged
merged 11 commits into from
Nov 14, 2022

Conversation

isabela-pf
Copy link
Contributor

Text styling

  • The blog is written with plain language (where relevant).
  • If there are headers, they use the proper header tags in order to do so (with only one level-one header).
  • All links describe where they link to (for example, check the Quansight labs website).
  • Any kind of styling that the author uses (for example, bold for emphasis) is consistent throughout the blog.

Non-text contents

  • All content is represented as text (for example, images need alt text and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing gifs or videos.
  • If it were to be read as plain text, the blog still makes sense and no information is missing.

This blog was requested by @trallard and written by @steff456 and myself. It announces Stephannie's work to make Pygments versions of existing accessible syntax highlighting themes and invites readers to try out the package.

This is my first time adding a blog post to the new website, so please let me know if I made a mistake so I can learn for the future. Thanks in advance for any feedback! 🌻

@vercel
Copy link

vercel bot commented Oct 21, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
consulting ✅ Ready (Inspect) Visit Preview Nov 14, 2022 at 4:50PM (UTC)
labs ✅ Ready (Inspect) Visit Preview Nov 14, 2022 at 4:50PM (UTC)

@asmeurer
Copy link
Member

This doesn't seem to be the case. The gifs here flash between the light and dark themes. Why not just show all the themes as multiple images?

@steff456
Copy link
Contributor

This doesn't seem to be the case. The gifs here flash between the light and dark themes. Why not just show all the themes as multiple images?

We could do any of them, I'm not sure which one will look better 😅

@isabela-pf
Copy link
Contributor Author

Thanks for the feedback, @asmeurer!

I've changed the blog images from animations to static images per request. While they weren't changing at high enough frames per second to meet the usual cut off for a dangerous flashing gif, I can see how the switch between light and dark mode could still be unpleasant.

Copy link
Member

@trallard trallard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor changes needed otherwise this looks good to me

apps/labs/posts/lets-make-pygments-accessible.md Outdated Show resolved Hide resolved
apps/labs/posts/lets-make-pygments-accessible.md Outdated Show resolved Hide resolved
apps/labs/posts/lets-make-pygments-accessible.md Outdated Show resolved Hide resolved
apps/labs/posts/lets-make-pygments-accessible.md Outdated Show resolved Hide resolved
apps/labs/posts/lets-make-pygments-accessible.md Outdated Show resolved Hide resolved
apps/labs/posts/lets-make-pygments-accessible.md Outdated Show resolved Hide resolved
apps/labs/posts/lets-make-pygments-accessible.md Outdated Show resolved Hide resolved
apps/labs/posts/lets-make-pygments-accessible.md Outdated Show resolved Hide resolved
apps/labs/posts/lets-make-pygments-accessible.md Outdated Show resolved Hide resolved
@isabela-pf
Copy link
Contributor Author

Hi again! I think I've addressed all the feedback listed above and moved the post date out to November 7. Please let me know if there's anything else you'd like me to address. Thank you!

@asmeurer
Copy link
Member

asmeurer commented Nov 2, 2022

Even ignoring the flashing concern, I prefer the style now used here because it makes it easier to compare the themes side-by-side.

@asmeurer
Copy link
Member

asmeurer commented Nov 2, 2022

I have a few high-level comments relating to the post. I know this is somewhat close to the posting deadline, so feel free to not address these if it's too much work (although I am curious about the answers for my own edification regardless).

  • The post doesn't seem to mention how the themes were created. Were they constructed from existing themes or created from scratch? If they were based on pre-existing themes were the color changes made by hand or using an automated tool?

  • Are there any plans to upstream these themes to pygments, or is the plan to only keep them in this separate package for now?

Also, it looks like the vercel build failed because of some YAML issue in the post metadata.

apps/labs/posts/lets-make-pygments-accessible.md Outdated Show resolved Hide resolved
apps/labs/posts/lets-make-pygments-accessible.md Outdated Show resolved Hide resolved
apps/labs/posts/lets-make-pygments-accessible.md Outdated Show resolved Hide resolved
apps/labs/posts/lets-make-pygments-accessible.md Outdated Show resolved Hide resolved
apps/labs/posts/lets-make-pygments-accessible.md Outdated Show resolved Hide resolved
@@ -0,0 +1,70 @@
---
title: '"Let's make Pygments accessible!"'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: '"Let's make Pygments accessible!"'
title: "Let's make Pygments accessible!"

Copy link
Contributor

@noatamir noatamir Nov 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the single quotes might be the issue here. Because of the apostrophe inside the Let's

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was with single quotes before so will need inspecting closer

Copy link
Contributor

@noatamir noatamir Nov 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, poorly phrased! I meant double as in double within single. two times the quotes needed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The author slug is correct. I checked that before commenting. This is what made me investigate the row above to begin with.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup we have tried few combos of the quotes.

@isabela-pf and @steff456 since it has been too much faff debugging this what about changing the title to "Making pygments accessible" 🙏🏽 ? At least to avoid delaying this once more

@@ -0,0 +1,70 @@
---
title: '"Let's make Pygments accessible!"'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup we have tried few combos of the quotes.

@isabela-pf and @steff456 since it has been too much faff debugging this what about changing the title to "Making pygments accessible" 🙏🏽 ? At least to avoid delaying this once more

apps/labs/posts/lets-make-pygments-accessible.md Outdated Show resolved Hide resolved
apps/labs/posts/lets-make-pygments-accessible.md Outdated Show resolved Hide resolved
apps/labs/posts/lets-make-pygments-accessible.md Outdated Show resolved Hide resolved
@steff456 steff456 changed the title [BLOG] Add Let's make Pygments Accessible [BLOG] Add Making pygments accessible Nov 14, 2022
@trallard
Copy link
Member

This is finally building and the content has been reviewed multiple times. Merging now 🚀

@trallard trallard merged commit cec538c into Quansight:develop Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants