Bug 36009 - Document koha-worker --queue elastic_index
Summary: Document koha-worker --queue elastic_index
Status: Passed QA
Alias: None
Product: Koha
Classification: Unclassified
Component: Command-line Utilities (show other bugs)
Version: master
Hardware: All All
: P5 - low minor (vote)
Assignee: Magnus Enger
QA Contact: Julian Maurice
URL:
Keywords:
Depends on: 32594
Blocks:
  Show dependency treegraph
 
Reported: 2024-02-07 07:17 UTC by Magnus Enger
Modified: 2024-02-23 10:00 UTC (History)
2 users (show)

See Also:
Change sponsored?: ---
Patch complexity: Trivial patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:


Attachments
Bug 36009: Document koha-worker --queue elastic_index (2.04 KB, patch)
2024-02-07 07:57 UTC, Magnus Enger
Details | Diff | Splinter Review
Bug 36009: Document koha-worker --queue elastic_index (2.09 KB, patch)
2024-02-10 19:47 UTC, David Nind
Details | Diff | Splinter Review
Bug 36009: Document koha-worker --queue elastic_index (2.16 KB, patch)
2024-02-23 10:00 UTC, Julian Maurice
Details | Diff | Splinter Review
Bug 36009: Document background_jobs_worker.pl --queue elastic_index (736 bytes, patch)
2024-02-23 10:00 UTC, Julian Maurice
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Magnus Enger 2024-02-07 07:17:25 UTC
koha-worker --help currently says: 

    --queue               Specify the queue/worker to restart - 'default' is used if not specified
                          current queues are: default, long_tasks

We should add elastic_index to the "current queues". 

"man koha-worker" only says: 

     Allows specifying the queue worker (defaults to 'default'). 

It would probably make sense to add a line about the actual queues there too.
Comment 1 Magnus Enger 2024-02-07 07:57:05 UTC
Created attachment 161796 [details] [review]
Bug 36009: Document koha-worker --queue elastic_index

To test:
- Copy the koha-worker script to the standard location:
  $ sudo cp debian/scripts/koha-worker /usr/sbin/koha-worker
- Check "sudo koha-worker --help" and verify elastic_index is
  mentioned in the list of "current queues"
- See https://wiki.koha-community.org/wiki/Testing_man_pages for
  how to check the "man" page. There should be a new paragraph
  about "Current queues" under "--queue"
Comment 2 David Nind 2024-02-10 19:47:42 UTC
Created attachment 162003 [details] [review]
Bug 36009: Document koha-worker --queue elastic_index

To test:
- Copy the koha-worker script to the standard location:
  $ sudo cp debian/scripts/koha-worker /usr/sbin/koha-worker
- Check "sudo koha-worker --help" and verify elastic_index is
  mentioned in the list of "current queues"
- See https://wiki.koha-community.org/wiki/Testing_man_pages for
  how to check the "man" page. There should be a new paragraph
  about "Current queues" under "--queue"

Signed-off-by: David Nind <david@davidnind.com>
Comment 3 Julian Maurice 2024-02-23 09:57:07 UTC Comment hidden (obsolete)
Comment 4 Julian Maurice 2024-02-23 10:00:38 UTC
Created attachment 162368 [details] [review]
Bug 36009: Document koha-worker --queue elastic_index

To test:
- Copy the koha-worker script to the standard location:
  $ sudo cp debian/scripts/koha-worker /usr/sbin/koha-worker
- Check "sudo koha-worker --help" and verify elastic_index is
  mentioned in the list of "current queues"
- See https://wiki.koha-community.org/wiki/Testing_man_pages for
  how to check the "man" page. There should be a new paragraph
  about "Current queues" under "--queue"

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Julian Maurice <julian.maurice@biblibre.com>
Comment 5 Julian Maurice 2024-02-23 10:00:41 UTC
Created attachment 162369 [details] [review]
Bug 36009: Document background_jobs_worker.pl --queue elastic_index

Signed-off-by: Julian Maurice <julian.maurice@biblibre.com>