Document: Adding background:queue commands: status and delete

[mmattel]

owncloud/core#31630 (Adding background:queue commands: status and delete)

Core PR already merged

Note:
owncloud/core#31727 (Harmonize printout: background:queue/execute commands)
https://github.com/owncloud/documentation/issues/4180 (Document: Add background:execute occ command for running cron jobs manually)

[mmattel]

Command output of:

sudo -uwww-data ./occ background:queue:status

+----+---------------------------------------------------+---------------------------+---------------+
| Id | Job                                               | Last run                  | Job Arguments |
+----+---------------------------------------------------+---------------------------+---------------+
| 1  | OCA\Files\BackgroundJob\ScanFiles                 | 2018-06-13T07:15:02+00:00 |               |
| 2  | OCA\Files\BackgroundJob\DeleteOrphanedItems       | 2018-06-13T06:30:03+00:00 |               |
| 3  | OCA\Files\BackgroundJob\CleanupFileLocks          | 2018-06-13T07:15:02+00:00 |               |
| 4  | OCA\DAV\CardDAV\SyncJob                           | 2018-06-12T19:15:02+00:00 |               |
| 5  | OCA\Federation\SyncJob                            | 2018-06-12T19:15:02+00:00 |               |
| 6  | OCA\Files_Sharing\DeleteOrphanedSharesJob         | 2018-06-13T07:00:05+00:00 |               |
| 7  | OCA\Files_Sharing\ExpireSharesJob                 | 2018-06-12T19:15:02+00:00 |               |
| 8  | OCA\Files_Trashbin\BackgroundJob\ExpireTrash      | 2018-06-13T07:00:05+00:00 |               |
| 9  | OCA\Files_Versions\BackgroundJob\ExpireVersions   | 2018-06-13T07:00:05+00:00 |               |
| 10 | OCA\UpdateNotification\Notification\BackgroundJob | 2018-06-12T19:15:03+00:00 |               |
| 11 | OC\Authentication\Token\DefaultTokenCleanupJob    | 2018-06-13T07:15:02+00:00 |               |
+----+---------------------------------------------------+---------------------------+---------------+

[mmattel]

Do not close until owncloud-archive/documentation#4207 (comment) (backport to stable10) is made.

[voroyam]

https://github.com/owncloud/documentation/blob/master/admin_manual/configuration/server/background_jobs_configuration.rst

where do you think should this be added in this document?

also What shold be added? the command output?

this? https://github.com/owncloud/documentation/blob/master/admin_manual/configuration/server/background_jobs_configuration.rst

[mmattel]

First of all it is a core occ command therefore in the occ command description.
in addition it must be described with the right text in the background job configuration description page

[voroyam]

First of all it is a core occ command therefore in the occ command description.

I don't understand. You already did a PR that does exactly this.
Why is this issue still open if you already did the PR yourself?

The only thing that is missing is the description of that command in the background job configuration page.

[voroyam]

Okay what I got so far:

A note from @tomneedham

Status and delete are useful commands, but only for debugging / analysis, not normal operation. This should be clear in any documentation.

owncloud/core#31630 (comment)

New command:

occ background:queue

Arguments

delete
status
Execute (why is this uppercase?)

Parameters for arguments

delete id

status Id

Execute jobId

---

IMHO this should be a template from all new implemented commands so there is less work for people who take time and write the documentation.

It's hard to sort through the commends of the PR and filter out what is a proposal, what has been implemented or to read code and imagine what the code means.

[mmattel]

IMHO this should be a template from all new implemented commands so there is less work for people who take time and write the documentation.

👍

[mmattel]

@phil-davis @DeepDiver1975 @PVince81
Because of
owncloud/core#34783 ([stable10] Adding background:queue commands: status and delete),
do I get this right that this will appear in 10.2, a doc PR needs to be filed and it must not be backported.

@settermjd