Page MenuHomePhabricator

Clean up doc/ folder & README
Open, MediumPublic

Description

The current README and doc/ folder is partly out of date and needs to be updated to reflect the work we did in the last two months or so.

We should also write a high-level 'what is restbase' summary, and publish it on https://www.mediawiki.org/wiki/RESTBase.

Related Objects

StatusSubtypeAssignedTask
ResolvedNone
OpenNone

Event Timeline

GWicke raised the priority of this task from to Medium.
GWicke updated the task description. (Show Details)
GWicke added a project: RESTBase.
GWicke added a subscriber: GWicke.
GWicke edited projects, added Services (next); removed Services.

I've got a RESTbase docker container happily running using RESTbase 0.16.9 and node:9.

Anything after this: 0.17.0, 0.18.0, 0.18.1 will not run providing a variety of node errors for modules not found.
This could be due to a breaking change in configuration I expect. Or something else.

If that sounds like a separate issue I'm happy to log one otherwise. However perhaps updated instructions in the README will resolve this in time?

I've got a RESTbase docker container happily running using RESTbase 0.16.9 and node:9.

Anything after this: 0.17.0, 0.18.0, 0.18.1 will not run providing a variety of node errors for modules not found.
This could be due to a breaking change in configuration I expect. Or something else.

Correct. Starting with 0.17.0 we have changed the storage model completely in a backwards-incompatible way. We indeed need to write some docs for how to set it up and incorporate the new version into MediaWiki-Containers (repo) so that people can easily use it out of the box.

Thank you @mobrovac for this very helpful answer. Has there been any progress on documentation? I'm keen to move to the more recent version at some stage.