Page MenuHomePhabricator

Review Sys Admin and Developer Documentation for Phonos
Closed, ResolvedPublic2 Estimated Story Points

Description

In preparation for our handover, we want to make sure that all documentation is in perfect shape.
This ticket to a make space and reserve some extra time to keep documentation up to date.

Questions to ask yourself:
Is the documentation up to date with the currently deployed version of Phonos?
Is the documentation appropriate for the reader addressed?
Is there documentation about how to extend the functionality of Phonos again, when another team or volunteer wants to make Phonos work with a TTS engine?
Has the current data tracking, currently implemented, been documented? (preferrably dev docs) What is being tracked and how does one add to it?

Event Timeline

KSiebert updated the task description. (Show Details)
Aklapper renamed this task from Review Sys Admin and Developer Documentation to Review Sys Admin and Developer Documentation for Phonos.Mar 30 2023, 1:11 PM
MusikAnimal set the point value for this task to 2.

I've added two new sections to the extension page:

I think this covers what is asked in the ticket. I didn't go into detail on the exact events we track, as they are visible in the linked dashboards.

Samwilson subscribed.

The improvements to the docs look great.

Looks good to me too, thanks for the updates! I'll move this to Done.

GMikesell-WMF moved this task from QA 🐛 to Done 🏁 on the Community-Tech (CommTech-Kanban) board.

As endorsed from above.