Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write usage guide for the scheduled maintenance feature #20763

Open
lukeheath opened this issue Jul 25, 2024 · 7 comments
Open

Write usage guide for the scheduled maintenance feature #20763

lukeheath opened this issue Jul 25, 2024 · 7 comments
Assignees
Labels
~engineering-initiated Engineering-initiated story, such as a bug, refactor, or contributor experience improvement. #g-endpoint-ops Endpoint ops product group :improve documentation Involves writing improvements or additions to documentation :product Product Design department (shows up on 🦢 Drafting board) story A user story defining an entire feature

Comments

@lukeheath
Copy link
Member

lukeheath commented Jul 25, 2024

Goal

User story
As a Fleet admin that wants to use the scheduled maintenance feature,
I want to read a usage guide that explains Fleet's best practice usage
so that I understand how the feature is expected to work.

Instructions for writing a usage guide are here: https://github.com/fleetdm/fleet/pull/20668/files

Context

Related tickets

@lukeheath lukeheath added story A user story defining an entire feature :product Product Design department (shows up on 🦢 Drafting board) :improve documentation Involves writing improvements or additions to documentation ~engineering-initiated Engineering-initiated story, such as a bug, refactor, or contributor experience improvement. :release Ready to write code. Scheduled in a release. See "Making changes" in handbook. #g-endpoint-ops Endpoint ops product group and removed :product Product Design department (shows up on 🦢 Drafting board) labels Jul 25, 2024
@lukeheath lukeheath added this to the 4.55.0-tentative milestone Jul 25, 2024
@lukeheath lukeheath added ~release blocker This story is currently blocking the next release of Fleet from going out. P2 Prioritize as urgent labels Jul 25, 2024
@lukeheath
Copy link
Member Author

lukeheath commented Jul 25, 2024

@sharon-fdm I realized we don't have a guide for the scheduled maintenance feature. We'll need to write and publish one before we release 4.55, so I'm creating this P2 release blocker to track the request. Please estimate this and assign out. We have a specific process for writing these using a template. Instructions for writing a usage guide are here: https://github.com/fleetdm/fleet/pull/20668/files. Will be in the engineering handbook soon. Thanks!

@RachelElysia
Copy link
Member

@sharon-fdm - Said he'll talk to @lukeheath about updating the reference AND/OR creating a guide as described above

@RachelElysia
Copy link
Member

@getvictor recording 7/31 incoming

@sharon-fdm
Copy link
Collaborator

@RachelElysia, as agreed, we will do both a Guide and update the ref doc.

@sharon-fdm
Copy link
Collaborator

@getvictor please review the document when you can.

@lukeheath lukeheath added :product Product Design department (shows up on 🦢 Drafting board) and removed :release Ready to write code. Scheduled in a release. See "Making changes" in handbook. labels Aug 9, 2024
@noahtalerman
Copy link
Member

Hey @lukeheath! I'm going over issues in confirm and celebrate column and I noticed that we decided to hold the guide: #20974 (comment)

What do you think we should do with this issue? We could leave it in confirm and celebrate until we're ready to ship the guide.

I think we could also ship the guide. I'm not sure why we want to wait for OS updates improvement. We don't mention OS updates in the guide: https://github.com/fleetdm/fleet/pull/20974/files

@lukeheath
Copy link
Member Author

@noahtalerman I think we have to hold it in confirm and celebrate so we don't forget to come back and publish it. Mike asked us to remove all scheduled maintenance content until we're confident in the OS upgrade workflow.

@lukeheath lukeheath removed ~release blocker This story is currently blocking the next release of Fleet from going out. P2 Prioritize as urgent labels Oct 2, 2024
@lukeheath lukeheath removed this from the 4.55.0 milestone Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
~engineering-initiated Engineering-initiated story, such as a bug, refactor, or contributor experience improvement. #g-endpoint-ops Endpoint ops product group :improve documentation Involves writing improvements or additions to documentation :product Product Design department (shows up on 🦢 Drafting board) story A user story defining an entire feature
Development

No branches or pull requests

5 participants