search

mediawiki-client-tools / mediawiki-dump-generator

Python 3 tools for downloading and preserving wikis
https://github.com/mediawiki-client-tools/mediawiki-scraper
GNU General Public License v3.0
89 stars 14 forks source link

README is getting a bit unwieldy... #173

Closed elsiehupp closed 2 months ago

elsiehupp commented 12 months ago

I mentioned in a recent PR review that I think at some point we should move the more detailed instructions out of the main README and into their own separate files.

What I think might work is each major platform having its own INSTALLATION file and there being a single main USAGE file for aspects that are common to all platforms.

At some point down the line it could make sense to put all this in, like, a readthedocs documentation site using Sphinx, but until then having separate Markdown files to read here on GitHub should work fine.

robkam commented 10 months ago

I've split README.md into INSTALLATION.md and USAGE.md and made a draft PR at #204.

robkam commented 10 months ago

Three options:

  1. Split USAGE.md into DUMPGENERATOR.md, LAUNCHER.md and UPLOADER.md ?
  2. Move LAUNCHER.md and UPLOADER.md sections into PUBLISHING.md ?
  3. For the time being, leave the documentation files as they are, (since PR 204)?
robkam commented 10 months ago

204 merged - README is now slimmed down.

ErroneousBosch commented 3 months ago

The Installation instructions aren't good for non-python people. For instance, I had no idea what poetry is and it doesn't come installed by default on Ubuntu 20.04.

robkam commented 3 months ago

The instructions are intended to be followed as given, even if their meaning isn't fully understood, as explaining them falls outside the project's scope and would make the documentation even more unwieldy.

robkam commented 2 months ago

The documentation has been sorted out.