Elgato_dark/fleet
1
0
Fork 0
mirror of https://github.com/fleetdm/fleet synced 2026-05-24 01:18:42 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 59

Codeowners: Reduce # of pings for reviews of docs (#7207)

Browse source 
* Codeowners: Reduce # of pings for reviews of docs

To avoid duplicative pings in Slack, reduce the number of folks who get automatically pinged about review requests when documentation, handbook, and website routes are changed.

I left Mike T and Chris both on the digital experience handbook so that PRs can be merged quickly there in many cases, regardless of timezone.

Also @chris-mcgillicuddy I made you responsible for either (a) approving and merging or (b) if there changes to meaning or code samples, requesting review from the on-call engineer.

* Update to reflect routing doc changes through Chris, and add sub-headings

* Pull the most relevant sentences to the top of each responsibility

* Use more peaceful language
This commit is contained in:
Mike McNeil 2022-08-19 12:44:04 -05:00 committed by GitHub
parent ecb428a904
commit 55aadfe092
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CODEOWNERS
View file

@ -20,7 +20,7 @@ go.mod @fleetdm/go
/CHANGELOG.md @noahtalerman
# Fleet documentation
/docs/ @Desmi-Dizney @chris-mcgillicuddy
/docs/ @chris-mcgillicuddy
# REST API reference documentation
/docs/Using-Fleet/REST-API.md @ksatter
@ -38,7 +38,7 @@ go.mod @fleetdm/go
/website/assets/ @eashaw
# Website redirects and URLs
/website/config/routes.js @eashaw @mike-j-thomas
/website/config/routes.js @eashaw
# Website backend, scripts, deps
/website/api/ @mikermcneil
@ -54,7 +54,7 @@ go.mod @fleetdm/go
# Handbook
/handbook/company @mikermcneil
/handbook/people @charlottechance @hollidayn
/handbook/people @charlottechance
/handbook/security @guillaumeross
/handbook/engineering @zwass
/handbook/product @noahtalerman

22
handbook/engineering/README.md
View file

@ -129,11 +129,27 @@ Documentation on completing the release process can be found
### Responsibilities
The on-call engineer is a second-line responder to questions raised by customers and community members. The community contact (Kathy) is responsible for the first response to GitHub issues, pull requests, and Slack messages in the osquery and other public Slacks. Kathy is also responsible for the first response to messages in private customer Slack channels. We respond within 1-hour (during business hours) for interactions and ask the on-call engineer to address any questions sent their way promptly. When Kathy is unavailable, the on-call engineer may sometimes be asked to take over the first response duties.
During their on-call shift, engineers temporarily take on a different set of priorities and responsibilities.
Pull requests may be routed through the on-call engineer for review. For PRs to the Fleet documentation, the content editor (Desmi) will request a review from the on-call. For PRs from the community, the community contact will a request review from the on-call. In either case, if the on-call has the knowledge and confidence to review, they should go ahead and do so. Otherwise, they should request a review from an engineer with the appropriate domain knowledge. It is the on-call engineer's responsibility to confirm that these PRs are moved forward (either by review with feedback or merge).
#### Responding quickly and finding answers
Additionally, the on-call engineer is asked to attend all the customer success meetings during the week. The engineer will receive calendar invitations from Tony for the appropriate meetings. This has a dual purpose of providing more context for how our customers use Fleet. Also, the engineer should actively participate and provide input where appropriate (if not sure, please ask your manager or Tony).
The on-call engineer is a second-line responder to questions raised by customers and community members. We respond within 1-hour (during business hours) for interactions and ask the on-call engineer to address any questions sent their way promptly.
Normally, the community contact (Kathy) is responsible for the first response to GitHub issues, pull requests, and Slack messages in the osquery and other public Slacks. Kathy is also responsible for the first response to messages in private customer Slack channels. When Kathy is unavailable, the on-call engineer may sometimes be asked to take over the first response duties.
#### Reviewing pull requests
Some pull requests are routed through the on-call engineer for review. It is the on-call engineer's responsibility to confirm that these PRs move forward quickly (either by review with feedback or merge).
For PRs from the community, the community contact ([Kathy](https://github.com/ksatter)) will request review from the on-call. For all PRs to the Fleet documentation, the content editor ([Chris McGillicuddy](https://github.com/chris-mcgillicuddy)) will either merge (for typo fixes, when only documentation files are changed) or request a review from the current on-call (for changes to code samples, or to the meaning of the text).
In either case, if the on-call has the knowledge and confidence to review, they should go ahead and do so. Otherwise, they should request a review from an engineer with the appropriate domain knowledge.
#### Attending meetings
The on-call engineer is asked to attend all the customer success meetings during the week.
The engineer will receive calendar invitations from Tony for the appropriate meetings. Besides giving Fleet's customers access to the expertise of the people who know the Fleet product best, this has a dual purpose of providing more context for how our customers use Fleet. Also, the engineer should actively participate and provide input where appropriate (if not sure, please ask your manager or Tony).
### Clearing the plate