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

[WIP] Add information about alt text #349

Merged
merged 5 commits into from
Oct 18, 2023
Merged

[WIP] Add information about alt text #349

merged 5 commits into from
Oct 18, 2023

Conversation

heitortsergent
Copy link
Contributor

@heitortsergent heitortsergent commented Oct 16, 2023

Add guidance about alt text and figure captions.

Copy link
Member

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

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

I love this already!

I think it will be a great complement to https://github.com/grafana/website/pull/15843.

Copy link
Contributor

@imatwawana imatwawana left a comment

Choose a reason for hiding this comment

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

This is great, thank you! I left one question/comment about the figure shortcode but other than a couple wording things, I think this is good.

docs/sources/write/image-guidelines/index.md Outdated Show resolved Hide resolved
docs/sources/write/image-guidelines/index.md Outdated Show resolved Hide resolved
```markdown
![Alt text](/media/<path-to-image/image-file.png>)
```

Copy link
Contributor

@imatwawana imatwawana Oct 17, 2023

Choose a reason for hiding this comment

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

I'm thinking we should add an example using a figure shortcode here as well.

Speaking of the shortcode, the alt parameter is indicated as not required and I'm sure it isn't for the shortcode to work; should we change that or add a note there to clarify what's meant by required in that context? cc @jdbaldry

Copy link
Member

Choose a reason for hiding this comment

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

I would like to make it required but it will break the website build if I do since so many invocations do not have that value set.

In my PR, I first emit a log warning which we can use to identify all the misuse. Once that's cleaned up, we can make it required.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated the PR to include an example with the figure shortcode as well. :)

@github-actions
Copy link
Contributor

github-actions bot commented Oct 18, 2023

Overall readability score: 60.16 (🟢 +0.09)

File Readability
index.md 64.51 (🟢 +4.01)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
index.md 64.51 50.73 9.32 9.8 11.7 7.42
  🟢 +4.01 🟢 +8.56 🟢 +0.28 🟢 +0.4 🟢 +0.47 🟢 +0.27

Averages:

  Readability FRE GF ARI CLI DCRS
Average 60.16 47.07 9.64 11.77 12.13 7.33
  🟢 +0.09 🟢 +0.2 🟢 +0.01 🟢 +0.01 🟢 +0.01 🟢 +0.01
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

@heitortsergent heitortsergent marked this pull request as ready for review October 18, 2023 19:12
Copy link
Contributor

@imatwawana imatwawana left a comment

Choose a reason for hiding this comment

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

LGTM!

@heitortsergent heitortsergent merged commit dae29fe into main Oct 18, 2023
5 checks passed
@heitortsergent heitortsergent deleted the alt-text branch October 18, 2023 19:43
@heitortsergent
Copy link
Contributor Author

Thanks for the review @imatwawana @jdbaldry! 🙇

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants