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

[stretch] Make a component to standardize image sizes for guides #328

Closed
caylahamann opened this issue Jun 29, 2020 · 4 comments · Fixed by #427
Closed

[stretch] Make a component to standardize image sizes for guides #328

caylahamann opened this issue Jun 29, 2020 · 4 comments · Fixed by #427
Assignees
Labels
enhancement New feature or request released sp:3 Story Point(s): 3

Comments

@caylahamann
Copy link
Contributor

Description

I think we should standardize on the image size and then build a component for that eventually.

@caylahamann caylahamann added the enhancement New feature or request label Jun 29, 2020
@caylahamann caylahamann added this to the Post release fixes milestone Jun 29, 2020
@caylahamann caylahamann added the sp:3 Story Point(s): 3 label Jun 30, 2020
@mmfred
Copy link
Contributor

mmfred commented Jun 30, 2020

These are the screenshot guidelines from the docs style guide:

Screenshots
Follow the New Relic Security guidelines to capture screenshots or other images. In addition:

Always crop or mask sensitive information.
Avoid annotating screenshots with text boxes, arrows, circles, etc.
Save the width at approximately 1200 to 1400 pixels.
Consider adding a caption.

@caylahamann
Copy link
Contributor Author

@mmfred We can set the width to be standardized and we could add an optional caption property to the component, but I don't think we can ensure (from our end) that we're always cropping or mask sensitive information or that they don't have text boxes or arrows. I assume that's more on the documentation side.

@djsauble would we want to have a caption property on images? and do you have any opinions on what that would look like?

@djsauble
Copy link
Contributor

djsauble commented Jul 9, 2020

@caylahamann I'd be happy to settle with using the alt attribute to caption images for now, so screen readers can deal with them.

That said, I notice that images on our docs site have captions, so if we're going to reuse this component across the sites we'll want to display the caption properly in a future version of this component.

@nr-opensource-bot
Copy link
Contributor

🎉 This issue has been resolved in version 1.5.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request released sp:3 Story Point(s): 3
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants