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)
Created attachment 75041 [details] [review] 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.
Related changes to the manual: https://tree.taiga.io/project/ldjamison-kohadocs-1805/us/22 https://gitlab.com/koha-community-devs-users/kohadocs/commit/949492cc9824054f2724c0c6293b46672a8f2bcd https://gitlab.com/koha-community-devs-users/kohadocs/commit/8ad495abf1e42c5e73c5cb62ec32e1a54d16f8e8
Link from Koha (bad link): https://koha-community.org/manual/18.05/html/systempreferences.html#automaticitemreturn Link with language code to updated manual (good link): https://koha-community.org/manual/18.05/en/html/systempreferences.html#automaticitemreturn
Created attachment 75235 [details] [review] 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.
Comment on attachment 75041 [details] [review] Bug 20706: Fixes the links to the manual to reflect changed chapter file names Review of attachment 75041 [details] [review]: ----------------------------------------------------------------- ::: 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="..."
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.
Created attachment 75322 [details] [review] Bug 20706: Fix bad HTML link to help file. Before there is no href. After there is.
Created attachment 75323 [details] [review] 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
Just noting - the problem found was not caused by this patch and could have gone on a separate report.
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.
Created attachment 75324 [details] [review] 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>
Please don't delay this any longer or we will have a release with broken help file links.
(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.
Created attachment 75337 [details] [review] 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
Comment on attachment 75337 [details] [review] 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.
Created attachment 75342 [details] [review] 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
Created attachment 75343 [details] [review] 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>
Created attachment 75344 [details] [review] 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>
Created attachment 75345 [details] [review] 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>
Created attachment 75346 [details] [review] 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>
Created attachment 75357 [details] [review] 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>
Created attachment 75358 [details] [review] 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>
Created attachment 75359 [details] [review] 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>
Created attachment 75360 [details] [review] 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>
Comment on attachment 75360 [details] [review] 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.
(In reply to Jonathan Druart from comment #25) > Comment on attachment 75360 [details] [review] [review] > Bug 20706: Add a help URL validator test > > These tests will slow down the test suite a lot 6min.
Pushed to master for 18.05, thanks to everybody involved!
(In reply to Jonathan Druart from comment #25) > Comment on attachment 75360 [details] [review] [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. :)