Page MenuHomePhabricator

Empower maps support by providing better documentation
Closed, ResolvedPublic

Description

Narrative
  • Given I am an SRE on-call with no prior maps knowledge or experience,
  • When I receive a request to work on maps,
  • Then I can quickly get an understanding from the available documentation without needing to consult a Maps-expert
Acceptance Criteria
  • All maps-related documentation are centralized and found in one place
  • All past maps incidents are documented
  • @wkandek or any engineer without any previous maps knowledge could explain how Maps works with confidence

Event Timeline

The first iteration of this documentation is intended to highlight the current state of the app and the infrastructure, here is what I have so far:

I started a document with an overall description of the new stack that can be a good starting point for more details.
https://wikitech.wikimedia.org/wiki/Maps/v2/Architecture

Change 724706 had a related patch set uploaded (by Jgiannelos; author: Jgiannelos):

[mediawiki/services/kartotherian@master] Add various diagrams for maps v2

https://gerrit.wikimedia.org/r/724706

Change 724706 merged by jenkins-bot:

[mediawiki/services/kartotherian@master] Add various diagrams for maps v2

https://gerrit.wikimedia.org/r/724706

Change 735323 had a related patch set uploaded (by Awight; author: Jgiannelos):

[mediawiki/services/kartotherian@wmde-maps-revid] Add various diagrams for maps v2

https://gerrit.wikimedia.org/r/735323

Change 735323 abandoned by Awight:

[mediawiki/services/kartotherian@wmde-maps-revid] Add various diagrams for maps v2

Reason:

accidentally cherry-picked

https://gerrit.wikimedia.org/r/735323

@MSantos Do you think the docs we currently have are enough for the scope of this ticket or should we put more effort for more docs?

@Jgiannelos I believe we need to finish the following page in order to resolve this ticket: https://wikitech.wikimedia.org/wiki/Maps/Maintenance

I think at this point https://wikitech.wikimedia.org/wiki/Maps/v2/Common_tasks is pretty stable and provides information for most of the manual maintenance tasks we do on maps.
Given how teams changed should we go ahead and close this ticket?