Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 2.3 KB

DocTriage.md

File metadata and controls

36 lines (28 loc) · 2.3 KB

Documentation triage

Documentation is hosted in github and from there rendered to PDF and the online view at Ubuntu Server docs. This kind of structure gave us better interaction rates and contributions than on Discourse, but to make them worthwhile we need to ensure we pick up and act on what we get there

Lists

For the daily triage rotation you only have to look at those issues or pull requests created or updated in the time your duty covers.

Check what the interaction is about and help them to progress and land or resolve.

Tag usage in Doc triage

Right now we have a few tags defined that help us to quickly see in what state an issue/PR was last time as well as later on allowing volunteers to better find how they could help us.

  • Review needed
    • review: technical: used by our Author, submitter and volunteer triagers, flagging that to go forward this needs a technical or even subject matter expert reviewer.
    • review: wording: used by our Engineers, submitter and volunteer triagers, flagging that to go forward this needs a review of an Author.
  • For:
    • Open Documentation Academy: used by triagers to declare a case as a good candidate to be resolved by volunteers of the Open Documentation Academy.
    • server: ToDo: mostly matching the server-todo launchpad tag, representing it is "valid and we should work on it"
  • state:* tags used to represet the state of a case
    • state:incomplete: this isn't actionable without further into being provided. This closely resembles an incomplete state in launchpad Bug triage.
    • state:wip: This PR is up for awareness, but not ready to be reviewed yet.
    • state:duplicate: This issue or pull request already exists, used represent why a case was closed.
    • state:invalid: This doesn't seem right, used represent why a case was closed.
  • Classifiations like code:* and content:* can be helpful more easily pick cases one can help with, adding them is optional