Skip to content

Commit

Permalink
Guidelines for adding images on docs (#6159)
Browse files Browse the repository at this point in the history
Added two bullet points.
  • Loading branch information
Desmi-Dizney authored Jun 8, 2022
1 parent 202faf9 commit 04e7ca3
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion handbook/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,8 @@ When adding or reordering a page, try to leave as much room between values as po
Try to keep images in the docs at a minimum. Images can be a quick way to help users understand a concept or direct them towards a specific user interface(UI) element. Still, too many can make the documentation feel cluttered and more difficult to maintain.

When adding images to the Fleet documentation, follow these guidelines:
- UI screenshots should be a 4:3 aspect ratio (1280x960). This is an optimal size for the container width of the docs and ensures that content in screenshots is as clear as possible to view in the docs (and especially on mobile devices).
- You can set up a custom preset in the Google Chrome device toolbar (in Developer Tools) to quickly adjust your browser to the correct size for taking a screenshot.
- Keep the images as simple as possible to maintain. Screenshots can get out of date quickly as UIs change.
- Exclude unnecessary images. Images should be used to help emphasize information in the docs, not replace it.
- Minimize images per doc page. For doc maintainers and users, more than one or two per page can get overwhelming.
Expand Down Expand Up @@ -414,4 +416,4 @@ This group maintains the following [Slack channels](https://fleetdm.com/handbook


<meta name="maintainedBy" value="ksatter">
<meta name="title" value="🪂 Community">
<meta name="title" value="🪂 Community">

0 comments on commit 04e7ca3

Please sign in to comment.