Page MenuHomePhabricator

[MSMF] [TECH] Make `docs/README.md` more succinct
Open, Needs TriagePublic

Description

The docs/README.md file in Mismatch Finder has become quite large and unseemly. We can make it a little slimmer and easier to parse if we extract dome parts of it into their own files.

Acceptance Criteria:

Related Objects

Event Timeline

ItamarWMDE renamed this task from Move some documentation out of docs/README.md into new docs: docs/RoutineMaintanance.md and docs/Troubleshooting.md to [MSMF] Move some documentation out of docs/README.md into new docs: docs/RoutineMaintanance.md and docs/Troubleshooting.md.Oct 26 2023, 5:01 PM
ItamarWMDE renamed this task from [MSMF] Move some documentation out of docs/README.md into new docs: docs/RoutineMaintanance.md and docs/Troubleshooting.md to [MSMF] [TECH] Move some documentation out of docs/README.md into new docs: docs/RoutineMaintanance.md and docs/Troubleshooting.md.
ItamarWMDE created this task.
ItamarWMDE moved this task from Incoming to [QT] By Project on the wmde-wikidata-tech board.
ItamarWMDE renamed this task from [MSMF] [TECH] Move some documentation out of docs/README.md into new docs: docs/RoutineMaintanance.md and docs/Troubleshooting.md to [MSMF] [TECH] Make `docs/README.md` more succinct.Oct 27 2023, 12:17 PM
HasanAkgun_WMDE subscribed.

Task Prio Notes:

Does not affect end users /production
Does not affect monitoring
Does not affect development efforts
Affects onboarding efforts (code style expectations are explicit)
Does not affect additional stakeholders

HasanAkgun_WMDE renamed this task from [MSMF] [TECH] Make `docs/README.md` more succinct to [SW] [MSMF] [TECH] Make `docs/README.md` more succinct.Feb 12 2024, 10:24 AM
HasanAkgun_WMDE renamed this task from [SW] [MSMF] [TECH] Make `docs/README.md` more succinct to [MSMF] [TECH] Make `docs/README.md` more succinct.Feb 28 2024, 9:38 AM