Page MenuHomeMiraheze

Consider creating a documentation tag on Phabricator
Closed, ResolvedPublic

Description

I think there is enough tasks to warrant this tag. If that is not the case feel free to decline this. I just figured it may be a good idea, but that's just a personal opinion.

A few examples of tasks that may fall under this:
T6977: Document Memcached
T6978: Document the MediaWiki Application Stack
T7214: Write docs for GHSA
T8070: Update docs for new deploy system
T8843: Implement documentation for all monitoring checks
T8847: Icinga docs entries for all Infrastructure monitoring
T8848: Icinga docs entries for all MediaWiki monitoring

Event Timeline

Unknown Object (User) triaged this task as Normal priority.Apr 10 2022, 16:10
Unknown Object (User) created this task.

While there's not that many documentation tasks I feel like it might be a sensible idea to start creating tasks for specific areas that need documentation as it's clear the current system where there's minimal tracking of docs and no one specifically assigned to work on doc X doesn't work. If we want to go this route and have tasks for areas that need docs/docs that need modifying then I'd agree with creating a tag to go along with it.

@John Any objections?

While there's not that many documentation tasks I feel like it might be a sensible idea to start creating tasks for specific areas that need documentation as it's clear the current system where there's minimal tracking of docs and no one specifically assigned to work on doc X doesn't work. If we want to go this route and have tasks for areas that need docs/docs that need modifying then I'd agree with creating a tag to go along with it.

@John Any objections?

This is a good idea, I think, based on the recent documentation-related tasks @Universal_Omega tagged. Could this tag also be used for tasks related to documentating MediaWiki Engineering or SRE (Infrastructure) incident reports, CVEs, or various other administrative report writing? Sometimes those can get quite involved, necessitating a task on Phabricator to assign a team member and track them through to completion. Or, alternatively, would a second tag for those sort of report writing tags be better?

Reception123 claimed this task.

Documentation created.

For @Dmehus's suggestion that would be a different tag if we wanted that, since that's quite different from docs.

Incident Reports and CVEs should be tracked as part of the original task, not requiring an additional task as until necessary follow up reports and learning is done, an incident shouldn’t be deemed resolved.

For protracted cases, a workboard column may be more appropriate than a tag.

In T9058#183674, @John wrote:

Incident Reports and CVEs should be tracked as part of the original task, not requiring an additional task as until necessary follow up reports and learning is done, an incident shouldn’t be deemed resolved.

For protracted cases, a workboard column may be more appropriate than a tag.

Ah, that makes sense, yeah. I agree that a workboard column would likely be more helpful for tracking and managing protracted incidents.

Documentation created.

For @Dmehus's suggestion that would be a different tag if we wanted that, since that's quite different from docs.

Thanks!