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] Improving Accessibility in JupyterLab #537

Merged
merged 25 commits into from
Nov 30, 2022

Conversation

kulsoomzahra
Copy link
Contributor

@kulsoomzahra kulsoomzahra commented Oct 30, 2022

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.

@vercel
Copy link

vercel bot commented Oct 30, 2022

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

Name Status Preview Updated
consulting ✅ Ready (Inspect) Visit Preview Nov 30, 2022 at 5:15AM (UTC)
labs ✅ Ready (Inspect) Visit Preview Nov 30, 2022 at 5:15AM (UTC)

@noatamir
Copy link
Contributor

noatamir commented Nov 2, 2022

👋
I will let @gabalafou give his review on the blog content first. But I just had a brief look at your meta-section, and a few comments to make:

  1. Please add a feature image. You can copy one of the existing ones if you would rather not make your own 😉
  2. Please correct the header indentation, specifically for the image source and alt text lines, to match this example: https://github.com/Quansight/Quansight-website#example-of-blog-post-meta-section. Otherwise, it will not render the images.
  3. Consider rewriting your description text. I think this description could be true for each of the internship blogs 🙃. Could you be a bit more specific? What would make people read it and want to read this specific blog about your internship experience and learnings?
    Thanks for all your work!

apps/labs/posts/improving-accessibility-in-jupyterlab.md Outdated Show resolved Hide resolved
apps/labs/posts/improving-accessibility-in-jupyterlab.md Outdated Show resolved Hide resolved
apps/labs/posts/improving-accessibility-in-jupyterlab.md Outdated Show resolved Hide resolved
apps/labs/posts/improving-accessibility-in-jupyterlab.md Outdated Show resolved Hide resolved
apps/labs/posts/improving-accessibility-in-jupyterlab.md Outdated Show resolved Hide resolved
apps/labs/posts/improving-accessibility-in-jupyterlab.md Outdated Show resolved Hide resolved
apps/labs/posts/improving-accessibility-in-jupyterlab.md Outdated Show resolved Hide resolved
apps/labs/posts/improving-accessibility-in-jupyterlab.md Outdated Show resolved Hide resolved
apps/labs/posts/improving-accessibility-in-jupyterlab.md Outdated Show resolved Hide resolved
apps/labs/posts/improving-accessibility-in-jupyterlab.md Outdated Show resolved Hide resolved
@gabalafou
Copy link
Contributor

gabalafou commented Nov 2, 2022

Great work, @kulsoomzahra! I made some suggestions. Please ask if you have any questions about any suggestion that I made. 😊

@kulsoomzahra
Copy link
Contributor Author

Please let me know if there's a need to squash these commits! Thank you

@kulsoomzahra
Copy link
Contributor Author

Also, I'm not sure why the gifs are not showing up in the preview.

Copy link
Contributor

@gabalafou gabalafou left a comment

Choose a reason for hiding this comment

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

@kulsoomzahra thanks for addressing the review comments!

Just a few more things to do:

  1. There were several suggestions I made that you did not accept. Could you either accept them or explain why you're not accepting them?
  2. Could you rename hero-image.png to something else, like accessibility+jupyter.png? (Don't forget to update the path once you change the image name.) I'm afraid it's a little confusing to call it hero image but then not to use it as the hero image.
  3. I made some new suggestions for the title and description. What do you think?

apps/labs/posts/improving-accessibility-in-jupyterlab.md Outdated Show resolved Hide resolved
apps/labs/posts/improving-accessibility-in-jupyterlab.md Outdated Show resolved Hide resolved
apps/labs/posts/improving-accessibility-in-jupyterlab.md Outdated Show resolved Hide resolved
apps/labs/posts/improving-accessibility-in-jupyterlab.md Outdated Show resolved Hide resolved
@kulsoomzahra
Copy link
Contributor Author

kulsoomzahra commented Nov 8, 2022

@gabalafou thanks for reviewing again!

I missed out some suggestions, but hopefully it's good now. The only concern I have right now is

  1. Why the GIFs are not showing up in the preview?
  2. I want the accessibility+jupyter image to show up as hero-image. That's the only image in the blog. But then what needs to be put in the featured image section? @noatamir maybe you could help me with this one, thanks!

@gabalafou
Copy link
Contributor

Why the GIFs are not showing up in the preview?

I'll look into it and get back to you.

alt: 'Accessibility and JupyterLab logos'
hero:
imageSrc: /posts/improving-accessibility-in-jupyterlab/labsbg.png
imageAlt: 'Accessibility and JupyterLab logos with Quansight labs graphical elements'
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
imageAlt: 'Accessibility and JupyterLab logos with Quansight labs graphical elements'
imageAlt: 'Jupyter Accessibility'

Copy link
Contributor

@gabalafou gabalafou left a comment

Choose a reason for hiding this comment

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

Hi @kulsoomzahra! This is looking great! I have just one last change request. The name of the markdown file serves as the slug for the URL, which means that your blog post would be at the URL: https://labs.quansight.org/blog/improving-accessibility-in-jupyterlab. I would prefer not to use that slug because it's so generic, and I think we may someday want to use that slug for a different blog post.

So would you mind changing the filename of your post to something like zoom-a11y-jupyterlab.md?

@kulsoomzahra
Copy link
Contributor Author

@gabalafou thanks for looping in! Let me know if everything's good.

Copy link
Contributor

@noatamir noatamir left a comment

Choose a reason for hiding this comment

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

LGTM. update the publish date to this Monday and let's merge this.
@gabalafou are there any outstanding changes you are waiting for?

---
title: 'Zoom zoom zoom! Improving Accessibility in JupyterLab'
author: kulsoom-zahra
published: October 31, 2022
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
published: October 31, 2022
published: November 28, 2022

@noatamir
Copy link
Contributor

Screenshot of the feature image in the Labs Blog page

@bskinn @gabalafou any idea why this blog appears twice in the Labs Blog page preview? I have never seen this before 🤷‍♀️

@bskinn
Copy link
Contributor

bskinn commented Nov 29, 2022

Where are you looking, @noatamir -- when I go to the preview for this PR, I can't even see this post at all.

Never mind, it's still dated Oct 31. I see it.

@bskinn
Copy link
Contributor

bskinn commented Nov 29, 2022

The post has two entries in /posts:

image

@noatamir
Copy link
Contributor

@kulsoomzahra can you please remove the markdown file you are not intending to publish from the PR?

@kulsoomzahra
Copy link
Contributor Author

Sure, on it.

@bskinn
Copy link
Contributor

bskinn commented Nov 29, 2022

@kulsoomzahra, please also rename the directory your post images are stored in so that they match the filename of your post's .md:

Per @gabalafou's comment, this will also avoid possible naming conflicts with a future post.

Thanks!

@noatamir
Copy link
Contributor

LGTM. Thanks @kulsoomzahra!

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

Successfully merging this pull request may close these issues.

8 participants