The transfer.py is a framework used for database backup and recovery. It lacks information about the parameters to be passed in the --help option. It will be useful for the user if this framework provides the same.
Description
Details
Status | Subtype | Assigned | Task | ||
---|---|---|---|---|---|
Resolved | jcrespo | T246435 Create or improve a tool for monitoring or automating tasks for Wikimedia databases | |||
Resolved | Privacybatm | T248256 GSoC 2020 Proposal: Improve the framework to transfer files over the LAN | |||
Resolved | Privacybatm | T253219 Add more information to --help option of transfer.py |
Event Timeline
Change 597569 had a related patch set uploaded (by Privacybatm; owner: Privacybatm):
[operations/software/wmfmariadbpy@master] transfer.py: Add information to --help option
Very related, the comment T252171#6152787 to make sure before we close a ticket with a new functionality, those are properly documented :-D on wiki and/or --help.
Just have a look at our documentation: https://transferpydoc.imfast.io/index.html :-)
(I uploaded it there to just have an easy look)
Change 598295 had a related patch set uploaded (by Privacybatm; owner: Privacybatm):
[operations/software/wmfmariadbpy@master] Write documentation using Sphinx
Change 598458 had a related patch set uploaded (by Privacybatm; owner: Privacybatm):
[operations/software/wmfmariadbpy@master] transfer.py: Modularize option_parse function
Change 597569 merged by Jcrespo:
[operations/software/wmfmariadbpy@master] transfer.py: Add information to --help option
Change 598458 merged by Jcrespo:
[operations/software/wmfmariadbpy@master] transfer.py: Modularize option_parse function
Change 598492 had a related patch set uploaded (by Jcrespo; owner: Jcrespo):
[integration/config@master] Schedule publishing sphinx documentation for wmfmariadbpy/transfer.py
Change 602719 had a related patch set uploaded (by Privacybatm; owner: Privacybatm):
[operations/software/transferpy@master] Write documentation using Sphinx
Change 598295 abandoned by Privacybatm:
Write documentation using Sphinx
Reason:
transferpy has moved from wmfmariadbpy project. So, the patch related to transferpy doc also need to be moved. The new patch is available at https://gerrit.wikimedia.org/r/c/operations/software/transferpy/ /602719
Change 602719 merged by Jcrespo:
[operations/software/transferpy@master] Write documentation using Sphinx
Change 598492 merged by jenkins-bot:
[integration/config@master] Schedule publishing sphinx documentation for transferpy
Mentioned in SAL (#wikimedia-releng) [2020-06-19T10:30:24Z] <hashar> Triggering documentation generation for transferpy (T253219): contint2001:~$ zuul enqueue --trigger gerrit --pipeline postmerge --project operations/software/transferpy --change 602719,9
We can close this, but let's remember to keep the help up-to-date with the new features implemented, as well as everything that is currently missing as it has not yet been fully decided.
Something I forgot, although the documentation is now published at https://doc.wikimedia.org/transferpy/ , it is not listed on the main page: https://doc.wikimedia.org/
An entry can be added by editing integration/docroot.git file org/wikimedia/doc/opensource.yaml. I am not sure under which section, maybe Infrastructure?
Change 607245 had a related patch set uploaded (by Jcrespo; owner: Jcrespo):
[integration/docroot@master] Add transferpy link to the doc.wikimedia.org homepage (infra)
Change 607245 merged by jenkins-bot:
[integration/docroot@master] Add transferpy link to the doc.wikimedia.org homepage (infra)