fleetdm / fleet

Open-source platform for IT, security, and infrastructure teams. (Linux, macOS, Chrome, Windows, cloud, data center)
https://fleetdm.com
Other
3k stars 416 forks source link

document (or improve docs) for complex MDM flows #17964

Open roperzh opened 6 months ago

roperzh commented 6 months ago

Goal

User story
As a fleet contributor,
I want to understand how fleet works
so that I can contribute efficiently, even if the person that implemented the complex feature is not around.

Context

Changes

Engineering

The following flows are hard to understand and not documented or poorly documented:

ℹ️  Please read this issue carefully and understand it. Pay special attention to UI wireframes, especially "dev notes".

QA

Risk assessment

Confirmation

  1. [ ] Engineer (@____): Added comment to user story confirming successful completion of QA.
  2. [ ] QA (@____): Added comment to user story confirming successful completion of QA.
lukeheath commented 6 months ago

@roperzh Thanks for the great engineering-initiated stories! I'll make sure to review these on my next pass.

lukeheath commented 3 months ago

As we grow our team and MDM efforts, this is an important investment to make sure Roberto's insights are properly documented and shared with other contributors.

I'm prioritizing to the drafting board for estimation. I'm also assigning @georgekarrv as product designer to work with Roberto to determine how the docs should like and where they'll live. I imagine in the contributor docs.

georgekarrv commented 2 months ago

Missed this today in est since I filter on #g-mdm. added and will just ask the team to est tomorrow.

georgekarrv commented 2 months ago

Hey team! Please add your planning poker estimate with Zenhub @dantecatalfamo @ghernandez345 @gillespi314 @jahzielv @roperzh