You are browsing a read-only backup copy of Wikitech. The live site can be found at wikitech.wikimedia.org

ONFIRE/Incident doc review workflow: Difference between revisions

From Wikitech-static
Jump to navigation Jump to search
imported>CDanis
mNo edit summary
 
imported>LMata
m (updating workboard link)
 
Line 1: Line 1:
Process for grooming our [https://phabricator.wikimedia.org/tag/sre-onfire-incident-docs/ Phabricator board]:
Process for grooming our [[phab:project/board/4626/|Phabricator board]]:


Review both wikitech and gdrive for new documents:
Review both wikitech and gdrive for new documents:
Line 5: Line 5:
* https://drive.google.com/drive/folders/1NaGMm8KzCWkVtQm4NbnS49ifbbbTO9bM (you're only concerned with 'proper' incident docs, not status documents)
* https://drive.google.com/drive/folders/1NaGMm8KzCWkVtQm4NbnS49ifbbbTO9bM (you're only concerned with 'proper' incident docs, not status documents)


Any new documents, create a task.  Task title is the title of the document, body is a link to the document & the names of authors.  Put it in the drafts column (or possibly in-review, if the document status is in-review).
Any new incidents, create a task or tag the task with [[phab:project/view/4626/|#SRE-OnFire]].  Task title is the title of the document, body is a link to the document & the names of authors.  Put it in the "'''Pending Review & Scorecard"''' column. Assigned tasks should be moved to the Phabricator work-board column with the corresponding quarter when the incident occurred (example: [[phab:project/view/5650/|#SRE-OnFIRE-FY2021-2022-Q2]])  


Any documents that have been drafts for longer than a week without seeing edits should be placed in-review (both edit the doc and move the task on the workboard).
=== General Guidelines ===


For documents that are in-review, ask on IRC to find reviewers for them.
* Incidents should be documented and scored within two weeks of the incident occurring.
 
* Any documents that have been unassigned for longer than a week after it happened should be assigned promptly, work with the IC for that incident to determine who is the best person to document and score the incident.
If a reviewer hasn't made progress on a doc in a week, feel free to ping them.
* For documents that are in-review, ask on IRC to find reviewers for them.
 
* If a reviewer hasn't made progress on a doc in a week, feel free to ping them.
If a document author hasn't replied to review comments in a week, feel free to ping them.
* If a document author hasn't replied to review comments in a week, feel free to ping them.
 
* Once the document and review process is complete, ensure the pertinent documentation is updated in Wikitech as applicable.
Once review comments have been addressed, close the task.
* Once review comments have been addressed, close the task in the same column pertaining to the quarter when the incident occurred.

Latest revision as of 22:41, 29 January 2022

Process for grooming our Phabricator board:

Review both wikitech and gdrive for new documents:

Any new incidents, create a task or tag the task with #SRE-OnFire. Task title is the title of the document, body is a link to the document & the names of authors. Put it in the "Pending Review & Scorecard" column. Assigned tasks should be moved to the Phabricator work-board column with the corresponding quarter when the incident occurred (example: #SRE-OnFIRE-FY2021-2022-Q2)

General Guidelines

  • Incidents should be documented and scored within two weeks of the incident occurring.
  • Any documents that have been unassigned for longer than a week after it happened should be assigned promptly, work with the IC for that incident to determine who is the best person to document and score the incident.
  • For documents that are in-review, ask on IRC to find reviewers for them.
  • If a reviewer hasn't made progress on a doc in a week, feel free to ping them.
  • If a document author hasn't replied to review comments in a week, feel free to ping them.
  • Once the document and review process is complete, ensure the pertinent documentation is updated in Wikitech as applicable.
  • Once review comments have been addressed, close the task in the same column pertaining to the quarter when the incident occurred.