Skip to content

Commit

Permalink
Create design-qa-considerations.md (#26774)
Browse files Browse the repository at this point in the history
Co-authored-by: Marko Lisica <[email protected]>
Co-authored-by: Noah Talerman <[email protected]>
Co-authored-by: Sam Pfluger <[email protected]>
  • Loading branch information
4 people authored Mar 7, 2025
1 parent dc7d1b3 commit 4b3e2a0
Show file tree
Hide file tree
Showing 2 changed files with 122 additions and 3 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/story.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ What else should contributors [keep in mind](https://fleetdm.com/handbook/compan
- Risk description: TODO <!-- If the risk level is high, explain why. If low, remove. -->

### Test plan
<!--
Add detailed manual testing steps for all affected user roles.
-->
<!-- Add detailed manual testing steps for all affected user roles. -->

> Make sure to go through [the list](https://github.com/fleetdm/fleet/blob/main/docs/Contributing/design-qa-considerations.md) and consider all events that might be related to this story, so we catch edge cases earlier.
1. Step 1
2. Step 2
Expand Down
119 changes: 119 additions & 0 deletions docs/Contributing/design-qa-considerations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
# Design / QA considerations

This is meant to be a helpful checklist of 'events' or 'transactions' to help catch edge cases sooner rather than later while designing or testing new features or bugs. Please feel free to add more if any are missing.

## User

- Create user
- Remove user
- Update user permissions
- API-only user

## Team

- Create team
- Remove team
- No team
- All teams
- Transfer host into this team
- Transfer host out of this team

## MDM

- Turn MDM on
- Turn MDM off
- Enable disk encryption
- Disable disk encryption
- Add ABM token
- Add multiple ABM tokens
- Remove ABM token
- Add VPP token
- Add multiple VPP tokens
- Remove VPP token
- Add minimum version OS updates
- Remove minimum version OS updates
- Add profile
- Remove profile
- Resend profile
- Add bootstrap package
- Remove bootstrap package
- Single host turn MDM off
- Setup experience software / scripts
- SSO enabled for DEP enrollment
- EULA added for DEP enrollment

## Software

- Add software to team
- FMA
- VPP
- custom package
- Remove software from team
- Edit software (scripts / binary)
- Add script
- Run script
- Edit script
- Remove script
- Vulnerability scans
- Automatic software install
- Label-scoped software install

## Policy

- Add policy
- Remove policy
- Add install automation
- Add Calendar automation

## Query

- Add query
- Remove query
- Edit query
- Live query
- Saved query results

## Labels

- Add dynamic label
- Remove dynamic label
- Add Manual label
- Remove Manual label
- Add host to an existing label
- Remove a host from a label
- Label selecion (policy / profile / software)
- Include all
- Include any
- Exclude all
- Exclude any

## Host

- Enroll to Fleet using Fleet's agent (fleetd)
- Enrolled via osquery (no orbit / fleetd)
- Deleted from Fleet
- DEP enrollment
- BYOD enrollment
- ABM ghost host before enrolled
- Wiped host
- Locked host
- Host that succeeds all policies
- Host with a failing policy
- Online host
- Offline host

## Integrations

- Jira
- Zendesk
- Webhooks

## Config

- Host callback times other than 1hr
- DB primary / replica
- Async ingestion of policies


<meta name="pageOrderInSection" value="3300">
<meta name="description" value="A helpful checklist of 'events' or 'transactions' to think about while designing or testing new features or bugs.">

0 comments on commit 4b3e2a0

Please sign in to comment.