[Bug 20706] New: Fix links to help files for changed file structure (removed numbering on files)
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 Bug ID: 20706 Summary: Fix links to help files for changed file structure (removed numbering on files) Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: Documentation Assignee: koha-bugs@lists.koha-community.org Reporter: katrin.fischer@bsz-bw.de QA Contact: testopia@bugs.koha-community.org With some clean-up done on the manual, we need to make sure the links to the manual still work alright: - remove the number part - check for links to systempreferences in help (now in their own chapter) -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords| |rel_18_05_candidate -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 --- Comment #1 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Created attachment 75041 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75041&action=edit Bug 20706: Fixes the links to the manual to reflect chanced chapter file names The numbering in front of the chapter file names has been removed, so the links need to be adapted accordingly. Note: Testing this in master currently won't work for 2 reasons: - We are still using 17.11 as version variable, will be 18.05 later. - We are missing the lanugage code before /html and this leads to an outdated version of the 18.05 manual. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 --- Comment #2 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Related changes to the manual: https://tree.taiga.io/project/ldjamison-kohadocs-1805/us/22 https://gitlab.com/koha-community-devs-users/kohadocs/commit/949492cc9824054... https://gitlab.com/koha-community-devs-users/kohadocs/commit/8ad495abf1e42c5... -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs Signoff Assignee|koha-bugs@lists.koha-commun |katrin.fischer@bsz-bw.de |ity.org | -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 --- Comment #3 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Link from Koha (bad link): https://koha-community.org/manual/18.05/html/systempreferences.html#automati... Link with language code to updated manual (good link): https://koha-community.org/manual/18.05/en/html/systempreferences.html#autom... -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 --- Comment #4 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Created attachment 75235 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75235&action=edit Bug 20706: Adds en language code to the links to the manual As we don't have a fix yet to link to the right translated manual, this adds /en to the links from the help files to the manual to make them work again. Check with both patches applied, that the links work. You will have to change 17.11 to 18.05. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #75041|Bug 20706: Fixes the links |Bug 20706: Fixes the links description|to the manual to reflect |to the manual to reflect |chanced chapter file names |changed chapter file names -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |mtompset@hotmail.com See Also| |https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=19817 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 --- Comment #5 from M. Tompsett <mtompset@hotmail.com> --- Comment on attachment 75041 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75041 Bug 20706: Fixes the links to the manual to reflect changed chapter file names Review of attachment 75041: --> (https://bugs.koha-community.org/bugzilla3/page.cgi?id=splinter.html&bug=20706&attachment=75041) ----------------------------------------------------------------- ::: koha-tmpl/intranet-tmpl/prog/en/modules/help/offline_circ/process_koc.tt @@ +16,4 @@
<p>You can also tend to pending circulation actions by going to Circulation > Pending offline circulation actions.</p>
+<p><strong>See the full documentation for Uploading the Offline Circulation File in the <a http://koha-community.org/manual/[% helpVersion %]/html/circulation.html#upload-offline-circ-file">manual</a> (online).</strong></p>
Please correct this HTML. It should be href="..." -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Failed QA --- Comment #6 from M. Tompsett <mtompset@hotmail.com> --- I wrote a test to scrape through all the modified pages' help. However, it discovered some bad HTML. Marking Failed QA for comment #5's issue. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Failed QA |Needs Signoff -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 --- Comment #7 from M. Tompsett <mtompset@hotmail.com> --- Created attachment 75322 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75322&action=edit Bug 20706: Fix bad HTML link to help file. Before there is no href. After there is. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 --- Comment #8 from M. Tompsett <mtompset@hotmail.com> --- Created attachment 75323 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75323&action=edit Bug 20706: Add a help URL validator test TEST PLAN ---------- 1) apply patch 2) kshell 3) prove t/db_dependent/www/help.t -- Add tests should pass -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 --- Comment #9 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Just noting - the problem found was not caused by this patch and could have gone on a separate report. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 --- Comment #10 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- I think the validator test should be discussed separately - I am not sure a list of files is the way to go as it will fall out of date pretty fast. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 --- Comment #11 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Created attachment 75324 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75324&action=edit Bug 20706: Fix bad HTML link to help file Before there is no href. After there is. Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #75322|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 --- Comment #12 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Please don't delay this any longer or we will have a release with broken help file links. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Severity|enhancement |critical --- Comment #13 from M. Tompsett <mtompset@hotmail.com> --- (In reply to Katrin Fischer from comment #12)
Please don't delay this any longer or we will have a release with broken help file links.
This isn't an enhancement, but a rather serious fix. Tweaking to critical. I'll sign off in a few hours, if it still isn't signed off. As for a list, a hard coded list will go out of date quickly, I'll see about building the equivalent list on the fly. But this test, even if not signed off, does trigger all the changes made in your two initial patches. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #75323|0 |1 is obsolete| | --- Comment #14 from M. Tompsett <mtompset@hotmail.com> --- Created attachment 75337 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75337&action=edit Bug 20706: Add a help URL validator test TEST PLAN ---------- 1) apply patch 2) kshell 3) prove t/db_dependent/www/help.t -- Add tests should pass -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #75337|0 |1 is obsolete| | --- Comment #15 from M. Tompsett <mtompset@hotmail.com> --- Comment on attachment 75337 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75337 Bug 20706: Add a help URL validator test Currently revised version is broken, but I don't want to prevent anyone else from signing off. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 --- Comment #16 from M. Tompsett <mtompset@hotmail.com> --- Created attachment 75342 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75342&action=edit Bug 20706: Add a help URL validator test TEST PLAN ---------- 1) apply patch 2) kshell 3) prove t/db_dependent/www/help.t -- Add tests should pass -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #75041|0 |1 is obsolete| | --- Comment #17 from M. Tompsett <mtompset@hotmail.com> --- Created attachment 75343 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75343&action=edit Bug 20706: Fixes the links to the manual to reflect changed chapter file names The numbering in front of the chapter file names has been removed, so the links need to be adapted accordingly. Note: Testing this in master currently won't work for 2 reasons: - We are still using 17.11 as version variable, will be 18.05 later. - We are missing the lanugage code before /html and this leads to an outdated version of the 18.05 manual. Signed-off-by: Mark Tompsett <mtompset@hotmail.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #75235|0 |1 is obsolete| | --- Comment #18 from M. Tompsett <mtompset@hotmail.com> --- Created attachment 75344 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75344&action=edit Bug 20706: Adds en language code to the links to the manual As we don't have a fix yet to link to the right translated manual, this adds /en to the links from the help files to the manual to make them work again. Check with both patches applied, that the links work. You will have to change 17.11 to 18.05. Signed-off-by: Mark Tompsett <mtompset@hotmail.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #75324|0 |1 is obsolete| | --- Comment #19 from M. Tompsett <mtompset@hotmail.com> --- Created attachment 75345 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75345&action=edit Bug 20706: Fix bad HTML link to help file Before there is no href. After there is. Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #75342|0 |1 is obsolete| | --- Comment #20 from M. Tompsett <mtompset@hotmail.com> --- Created attachment 75346 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75346&action=edit Bug 20706: Add a help URL validator test TEST PLAN ---------- 1) apply patch 2) kshell 3) prove t/db_dependent/www/help.t -- Add tests should pass Signed-off-by: Mark Tompsett <mtompset@hotmail.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 Nick Clemens <nick@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- QA Contact|testopia@bugs.koha-communit |nick@bywatersolutions.com |y.org | CC| |nick@bywatersolutions.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 Nick Clemens <nick@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 Nick Clemens <nick@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #75343|0 |1 is obsolete| | Attachment #75344|0 |1 is obsolete| | Attachment #75345|0 |1 is obsolete| | Attachment #75346|0 |1 is obsolete| | --- Comment #21 from Nick Clemens <nick@bywatersolutions.com> --- Created attachment 75357 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75357&action=edit Bug 20706: Fixes the links to the manual to reflect chanced chapter file names The numbering in front of the chapter file names has been removed, so the links need to be adapted accordingly. Note: Testing this in master currently won't work for 2 reasons: - We are still using 17.11 as version variable, will be 18.05 later. - We are missing the lanugage code before /html and this leads to an outdated version of the 18.05 manual. Signed-off-by: Mark Tompsett <mtompset@hotmail.com> Signed-off-by: Nick Clemens <nick@bywatersolutions.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 --- Comment #22 from Nick Clemens <nick@bywatersolutions.com> --- Created attachment 75358 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75358&action=edit Bug 20706: Adds en language code to the links to the manual As we don't have a fix yet to link to the right translated manual, this adds /en to the links from the help files to the manual to make them work again. Check with both patches applied, that the links work. You will have to change 17.11 to 18.05. Signed-off-by: Mark Tompsett <mtompset@hotmail.com> Signed-off-by: Nick Clemens <nick@bywatersolutions.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 --- Comment #23 from Nick Clemens <nick@bywatersolutions.com> --- Created attachment 75359 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75359&action=edit Bug 20706: Fix bad HTML link to help file Before there is no href. After there is. Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> Signed-off-by: Nick Clemens <nick@bywatersolutions.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 --- Comment #24 from Nick Clemens <nick@bywatersolutions.com> --- Created attachment 75360 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75360&action=edit Bug 20706: Add a help URL validator test TEST PLAN ---------- 1) apply patch 2) kshell 3) prove t/db_dependent/www/help.t -- Add tests should pass Signed-off-by: Mark Tompsett <mtompset@hotmail.com> Signed-off-by: Nick Clemens <nick@bywatersolutions.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |19817 See Also|https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=19817 | Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19817 [Bug 19817] Merge local and online documentations -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |jonathan.druart@bugs.koha-c | |ommunity.org Attachment #75360|0 |1 is obsolete| | --- Comment #25 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- Comment on attachment 75360 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=75360 Bug 20706: Add a help URL validator test These tests will slow down the test suite a lot and will conflict with bug 19817. Moreover the version is hardcoded. I do not think it makes sense to have it in the codebase. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 --- Comment #26 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- (In reply to Jonathan Druart from comment #25)
Comment on attachment 75360 [details] [review] Bug 20706: Add a help URL validator test
These tests will slow down the test suite a lot
6min. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Passed QA |Pushed to Master --- Comment #27 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- Pushed to master for 18.05, thanks to everybody involved! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 --- Comment #28 from M. Tompsett <mtompset@hotmail.com> --- (In reply to Jonathan Druart from comment #25)
Comment on attachment 75360 [details] [review] Bug 20706: Add a help URL validator test
These tests will slow down the test suite a lot
That is a valid reason to not push.
and will conflict with bug 19817.
Okay. But conflicts can be resolved. But yes, I suppose it would become pointless if 19817 gets pushed through.
Moreover the version is hardcoded.
No, the version isn't hard coded. The initial version is substituted.
I do not think it makes sense to have it in the codebase.
Okay, but it certainly made testing easier. :) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=20706 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords|rel_18_05_candidate | Resolution|--- |FIXED CC| |martin.renvoize@ptfs-europe | |.com Status|Pushed to Master |RESOLVED -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org