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

enhancement(docs): Remove entries in dictionary.txt and fix alt text values in docs files #26022

Merged
merged 5 commits into from
Sep 4, 2020
Merged

Conversation

meyian
Copy link
Contributor

@meyian meyian commented Jul 25, 2020

Description

This removes "allfile-query", "filesystem-autocomplete", "filesystem-query" and "graphiql-filesystem" from dictionary.txt. These terms occurred in both the sourcing-from-the-filesystem.md and tutorial/part-five/index.md files, so both these files were edited to remove these terms. The terms were found in alt text values, so they were replaced with more descriptive phrases.

Documentation

No documentation required for this change.

Related Issues

Addresses #25290.

@meyian meyian requested a review from a team as a code owner July 25, 2020 18:13
@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Jul 25, 2020
@blainekasten blainekasten added status: needs docs review Pull request related to documentation waiting for review and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Jul 27, 2020
Copy link

@AishaBlake AishaBlake left a comment

Choose a reason for hiding this comment

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

Hey, @meyian! Thank you so much for this contribution! This is a really awesome improvement.

Would you mind removing any instances of "Screenshot of" in these files? I know we do it in several blog posts a few other places in the docs but it's generally not necessary information. Screen readers users will know these are images, so we don't need to repeat that each one is a screenshot in the alt text.

Also, it looks like we're still getting lint warnings for instances of "allFile".

Once that's done, I'm happy to have another look. Thanks again!

@AishaBlake AishaBlake added type: documentation An issue or pull request for improving or updating Gatsby's documentation and removed status: needs docs review Pull request related to documentation waiting for review labels Jul 31, 2020
@muescha

This comment has been minimized.

@meyian
Copy link
Contributor Author

meyian commented Aug 2, 2020

Hey, @meyian! Thank you so much for this contribution! This is a really awesome improvement.

Would you mind removing any instances of "Screenshot of" in these files? I know we do it in several blog posts a few other places in the docs but it's generally not necessary information. Screen readers users will know these are images, so we don't need to repeat that each one is a screenshot in the alt text.

Also, it looks like we're still getting lint warnings for instances of "allFile".

Once that's done, I'm happy to have another look. Thanks again!

Sure thing! I've removed references to "allFile" and instances of "Screenshot of."

@meyian meyian requested a review from AishaBlake August 2, 2020 18:15
Copy link
Contributor

@LekoArts LekoArts left a comment

Choose a reason for hiding this comment

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

Changed the "Screenshot of" in the docs files, the blog posts are not sourced from here anymore so it's something we'll need to take care of in WordPress.

So this is good to go, thanks a lot! 👍

@LekoArts LekoArts dismissed AishaBlake’s stale review September 4, 2020 08:48

Changes addressed

@LekoArts LekoArts merged commit a7945f7 into gatsbyjs:master Sep 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants