-
Notifications
You must be signed in to change notification settings - Fork 13
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
Conversation
There was a problem hiding this 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.
There was a problem hiding this 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.
```markdown | ||
![Alt text](/media/<path-to-image/image-file.png>) | ||
``` | ||
|
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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. :)
Co-authored-by: Isabel <[email protected]>
Overall readability score: 60.16 (🟢 +0.09)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Thanks for the review @imatwawana @jdbaldry! 🙇 |
Add guidance about alt text and figure captions.