Bug 33790 - Fix and add various links to the manual
Summary: Fix and add various links to the manual
Status: RESOLVED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Main
Hardware: All All
: P5 - low normal
Assignee: Katrin Fischer
QA Contact: Testopia
URL:
Keywords:
: 33757 (view as bug list)
Depends on: 31378
Blocks: 34702
  Show dependency treegraph
 
Reported: 2023-05-21 19:52 UTC by hebah
Modified: 2023-12-28 20:47 UTC (History)
4 users (show)

See Also:
Change sponsored?: ---
Patch complexity: Small patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:
23.11.00,23.05.02,22.11.08
Circulation function:


Attachments
Bug 33790: Fix and add various links to the manual (11.60 KB, patch)
2023-05-29 19:43 UTC, Katrin Fischer
Details | Diff | Splinter Review
Bug 33790: Fix and add various links to the manual (11.65 KB, patch)
2023-06-01 19:13 UTC, David Nind
Details | Diff | Splinter Review
Bug 33790: Fix and add various links to the manual (11.72 KB, patch)
2023-07-07 08:18 UTC, Jonathan Druart
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description hebah 2023-05-21 19:52:49 UTC
The new identity_providers integration in the staff client introduced via bug 31378 does not link to a relevant section in the help manual. 

I'm also not seeing information on it in the manual where I would expect it: https://koha-community.org/manual//22.11/en/html/administration.html#additional-parameters
Comment 1 Katrin Fischer 2023-05-29 19:22:30 UTC
Identity providers is not the only one, patch incoming.
Comment 2 Katrin Fischer 2023-05-29 19:43:05 UTC
Created attachment 151790 [details] [review]
Bug 33790: Fix and add various links to the manual

* Makes the move from tools to cataloguing for the pages linked
  from the cataloguing start page
* Adds missing help links to admin and tools pages
* Fix other existing links

To test:
* Best is to look at the patch, you'll see the pages you need
  to test on the left.
* Open the page and access the help page through the help link
  Note: for a few links you'll need to update the version in the
  URL to 23.05 (identity providers is one) as the page doesn't
  exist yet in the 22.11 manual
Comment 3 David Nind 2023-06-01 19:13:36 UTC
Created attachment 151952 [details] [review]
Bug 33790: Fix and add various links to the manual

* Makes the move from tools to cataloguing for the pages linked
  from the cataloguing start page
* Adds missing help links to admin and tools pages
* Fix other existing links

To test:
* Best is to look at the patch, you'll see the pages you need
  to test on the left.
* Open the page and access the help page through the help link
  Note: for a few links you'll need to update the version in the
  URL to 23.05 (identity providers is one) as the page doesn't
  exist yet in the 22.11 manual

Signed-off-by: David Nind <david@davidnind.com>
Comment 4 David Nind 2023-06-01 19:24:13 UTC
Testing notes (using KTD):

1. I amended the patch (instead of adding a follow-up) for SMTP servers: 'admin/smtp-servers' should be  'admin/smtp_servers' (underscore instead of a dash in the URL).

2. I did try to see if the more specific URLs and links could be added for Cataloging > Tools > Label creator > Manage [Label batches|Layouts|Label templates|Printer profiles], as they each have their own section in the manual. 

   However, the URLs for the specific manage options all start with 'label-manage.pl?label-element=', and there doesn't appear to be a way to map a page with a ? to a specific bookmark in the manual.
Comment 5 Katrin Fischer 2023-06-01 20:24:11 UTC
*** Bug 33757 has been marked as a duplicate of this bug. ***
Comment 6 Jonathan Druart 2023-07-07 08:18:08 UTC
Created attachment 153124 [details] [review]
Bug 33790: Fix and add various links to the manual

* Makes the move from tools to cataloguing for the pages linked
  from the cataloguing start page
* Adds missing help links to admin and tools pages
* Fix other existing links

To test:
* Best is to look at the patch, you'll see the pages you need
  to test on the left.
* Open the page and access the help page through the help link
  Note: for a few links you'll need to update the version in the
  URL to 23.05 (identity providers is one) as the page doesn't
  exist yet in the 22.11 manual

Signed-off-by: David Nind <david@davidnind.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Comment 7 Tomás Cohen Arazi (tcohen) 2023-07-07 12:18:47 UTC
Pushed to master for 23.11.

Nice work everyone, thanks!
Comment 8 Katrin Fischer 2023-07-08 13:01:13 UTC
Thank you! Should be ok for 23.05 and 22.11 as well. A lot of it is reflecting the changes made for the cataloguing start page.
Comment 9 Martin Renvoize (ashimema) 2023-07-18 09:11:57 UTC
Thanks for all the hard work!

Pushed to 23.05.x for the next release
Comment 10 Matt Blenkinsop 2023-07-18 13:46:25 UTC
Nice work everyone!

Pushed to oldstable for 22.11.x