From 739a1d8f8db831b333bf31368a3e84517ab5d420 Mon Sep 17 00:00:00 2001 From: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com> Date: Tue, 26 Oct 2021 14:17:17 +0900 Subject: [PATCH] Updated product section of handbook (#2680) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Updated product section of handbook • Changed section heading Fleet EE to "UI design". • Added sub-section "Design conventions" under UI design. • Re-ordered content. I felt that QA and release process was of more importance than UI design. * Update README.md --- handbook/README.md | 4 ++-- handbook/product.md | 50 ++++++++++++++++++++++++++------------------- 2 files changed, 31 insertions(+), 23 deletions(-) diff --git a/handbook/README.md b/handbook/README.md index 64e07eb81c..d736461494 100644 --- a/handbook/README.md +++ b/handbook/README.md @@ -20,8 +20,6 @@ The Fleet handbook is the central guide for how we run the company. As part of o ### Product -[Fleet EE](./product.md#fleet-ee) - [Fleet docs](./product.md#fleet-docs) [Manual QA](./product.md#manual-qa) @@ -30,6 +28,8 @@ The Fleet handbook is the central guide for how we run the company. As part of o [Support process](./product.md#release-process) +[UI design](./product.md#ui-design) + ### Growth [Promoting blog posts on social media](./growth.md#promoting-blog-posts-on-social-media) diff --git a/handbook/product.md b/handbook/product.md index eee74a5294..d3a61dd074 100644 --- a/handbook/product.md +++ b/handbook/product.md @@ -1,25 +1,4 @@ -## Fleet EE - -### Communicating design changes to Engineering -For something NEW that has been added to [Figma Fleet EE (current, dev-ready)](https://www.figma.com/file/qpdty1e2n22uZntKUZKEJl/?node-id=0%3A1): -1. Create a new [GitHub issue](https://github.com/fleetdm/fleet/issues/new) -2. Detail the required changes (including page links to the relevant layouts), then assign it to the __“Initiatives”__ project. - -Assign to Initiatives project - -> ___NOTE:___ Artwork and layouts in Figma Fleet EE (current, dev-ready) are final assets, ready for implementation. Therefore, it’s important NOT to use the “idea” label, as designs in this document are more than ideas - they are something that WILL be implemented._ - -3. Navigate to the [Initiatives project](https://github.com/orgs/fleetdm/projects/8), and hit “+ Add cards”, pick the new issue, and drag it into the “🤩Inspire me” column. - -Add cards - -Inspire me - -### Communicating unplanned design changes - -For issues related to something that was ALREADY in Figma Fleet EE (current, dev-ready), but __implemented differently__, e.g, padding/spacing inconsistency etc. Create a [bug issue](https://github.com/fleetdm/fleet/issues/new?assignees=&labels=bug%2C%3Areproduce&template=bug-report.md&title=) and detail the required changes. - ## Fleet docs ### Adding a link to the Fleet docs @@ -351,6 +330,35 @@ There are several locations in Fleet's public and internal documentation that ca 2. The [Internal FAQ](https://docs.google.com/document/d/1I6pJ3vz0EE-qE13VmpE2G3gd5zA1m3bb_u8Q2G3Gmp0/edit#heading=h.ltavvjy511qv) document. +## UI Design + +### Communicating design changes to Engineering +For something NEW that has been added to [Figma Fleet EE (current, dev-ready)](https://www.figma.com/file/qpdty1e2n22uZntKUZKEJl/?node-id=0%3A1): +1. Create a new [GitHub issue](https://github.com/fleetdm/fleet/issues/new) +2. Detail the required changes (including page links to the relevant layouts), then assign it to the __“Initiatives”__ project. + +Assign to Initiatives project + +> ___NOTE:___ Artwork and layouts in Figma Fleet EE (current, dev-ready) are final assets, ready for implementation. Therefore, it’s important NOT to use the “idea” label, as designs in this document are more than ideas - they are something that WILL be implemented._ + +3. Navigate to the [Initiatives project](https://github.com/orgs/fleetdm/projects/8), and hit “+ Add cards”, pick the new issue, and drag it into the “🤩Inspire me” column. + +Add cards + +Inspire me + +### Communicating unplanned design changes + +For issues related to something that was ALREADY in Figma Fleet EE (current, dev-ready), but __implemented differently__, e.g, padding/spacing inconsistency etc. Create a [bug issue](https://github.com/fleetdm/fleet/issues/new?assignees=&labels=bug%2C%3Areproduce&template=bug-report.md&title=) and detail the required changes. + +### Design conventions + +We have certain design conventions that we include in Fleet. We will document more of these over time. + +**Table empty states** + +Use `---`, with color `$ui-fleet-black-50` as the default UI for empty columns. +