Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-05-23 17:08:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 83

Guidelines for adding images on docs (#6159)

Browse source 
Added two bullet points.
This commit is contained in:
Desmi-Dizney 2022-06-08 17:58:23 -05:00 committed by GitHub
parent 202faf9b74
commit 04e7ca3ccb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
handbook/community.md
View file

@ -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.
@ -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">