Bug 36009

Summary: Document koha-worker --queue elastic_index
Product: Koha Reporter: Magnus Enger <magnus>
Component: Command-line UtilitiesAssignee: Magnus Enger <magnus>
Status: Pushed to oldstable --- QA Contact: Julian Maurice <julian.maurice>
Severity: minor    
Priority: P5 - low CC: fridolin.somers, julian.maurice, lucas, robin
Version: Main   
Hardware: All   
OS: All   
Change sponsored?: --- Patch complexity: Trivial patch
Documentation contact: Documentation submission:
Text to go in the release notes:
Version(s) released in:
24.05.00,23.11.04,23.05.10
Bug Depends on: 32594    
Bug Blocks:    
Attachments: Bug 36009: Document koha-worker --queue elastic_index
Bug 36009: Document koha-worker --queue elastic_index
Bug 36009: Document koha-worker --queue elastic_index
Bug 36009: Document background_jobs_worker.pl --queue elastic_index

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>
Comment 6 Katrin Fischer 2024-03-07 13:44:08 UTC
I LOVE documentation patches :)
Comment 7 Katrin Fischer 2024-03-07 14:04:20 UTC
Pushed for 24.05!

Well done everyone, thank you!
Comment 8 Fridolin Somers 2024-03-11 09:38:56 UTC
Pushed to 23.11.x for 23.11.04
Comment 9 Lucas Gass 2024-03-19 15:25:31 UTC
Backported to 23.05.x for upcoming 23.05.10.