Page MenuHomePhabricator

Update installation instructions on mw:Extension:Wikispeech
Closed, ResolvedPublic

Description

The current installation instructions at mw:Extension:Wikispeech mix wmflabs specific instructions, developer instructions (screen) while outsourcing most of the instructions to STTS pages on github.

We should:

  • Rebuild the page with the wmflabs and developer instructions on a subpage.
  • The remaining installation instructions should be clearly separated into TTS service and Wikispeech extension.
  • For the TTS service/server the instructions should ideally be presented on the wikipage. We can link out to the github page for more in-depth info.
  • Add end user documentation. Use http://wikispeech.wmflabs.org/wiki/Help:Wikispeech/en as a start.

The page also contains plenty of other placeholder/default text which could be removed and some info (available parameters, default values, used hooks) are likely outdated and should be updated.

Since we are still not bumping the version (we're on v. 0.0.1) it might be worth making a note somewhere about up to which point we've updated the documentation.

Event Timeline

Take this opportunity to bump the version to 0.1.0 from now on bump the last digit when new features are introduced. bump the middle digit when we break things or TTS-server behaviour has changed. Likely means introducing a (siple) changelog.

Consider a compatibility matrix for extension to server.

Also add end user instructions. There exists some on the demo-wiki that can be updated and used for this. The default URL for the help button can then be set to this.

Also add end user instructions. There exists some on the demo-wiki that can be updated and used for this. The default URL for the help button can then be set to this.

Just to clarify. Do you intend to copy the instructions from the demo wiki to mediawiki.org or for the default to point to the demo wiki? (First sounds like a good plan, second is problematic)

Yes, copying the instructions to the MW-wiki is the plan.

I have cleaned up, updated and broken out various things in the page. Here's what was done: https://www.mediawiki.org/w/index.php?title=Extension%3AWikispeech&type=revision&diff=2826212&oldid=2825727. Subpage for wmflabs-installation and an end user help page were created, both linked in the extension page.

@Lokal_Profil, can you take a look and see if anything more should be added, if I removed something I shouldn't have or if anything else looks wrong?

Sorry for this taking forever. Can't see anything obviously missing, added a link but otherwise no changes.

When we have a clearer idea of how to package and deploy the TTS-server (in production) we can expand on that (on the Extension page or a subpage) but until then this should be enough.