Bug 18876 - Broken links in Koha documentation
Summary: Broken links in Koha documentation
Status: CLOSED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Main
Hardware: All All
: P5 - low normal
Assignee: Bugs List
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2017-06-28 18:52 UTC by Pablo AB
Modified: 2020-11-17 20:06 UTC (History)
1 user (show)

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


Attachments
linkchecker-gui output report in XML, CSV and HTML. (17.17 KB, application/zip)
2017-06-28 18:52 UTC, Pablo AB
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Pablo AB 2017-06-28 18:52:15 UTC
Created attachment 64711 [details]
linkchecker-gui output report in XML, CSV and HTML.

I found some broken links in Koha documentation, particularly related to fragments (AKA in-page, local) links, within same HTML.
For example on [Tools section](https://koha-community.org/manual/17.05/html/03_tools.html), the left side table of contents correctly point to #marc-modification-templates fragment, but in some partes and itself on the title incorrectly point to non-existent #marcmodtemplates. This is very annoying while reading documentation.

I couldn't find a way to list all broken in-page links. I tried:

+ http://validator.w3.org/checklink
+ wget --spider  -o wget.log  -e robots=off --wait 1 -r -p https://koha-community.org/manual/17.05/html/ 
+ linkchecker-gui
+ https://www.npmjs.com/package/broken-link-checker
	`blc https://koha-community.org/manual/17.05/html/ -roe`

Attached to this bug the linkchecker-gui results using [this](https://koha-community.org/manual/17.05/html/) as starting URL. It found 231 broken URLs, but not local ones.

PS: Markdown on this bugzilla would be great.
Comment 1 Katrin Fischer 2017-07-04 05:47:56 UTC
Hi Pablo,
thx for reporting and for the list. We are aware that a lot of links need to be fixed with the change to Sphinx as the headings/anchors have changed. Please take a look at https://wiki.koha-community.org/wiki/Editing_the_Koha_Manual for some of the ongoing work on the manual :)
Comment 2 Katrin Fischer 2017-08-15 23:05:20 UTC
Hi Pablo, 

Jonathan has provided a big fix to the broken links in the manual, there remain some that we have to fix manually, but most should now work ok:

https://gitlab.com/koha-community-devs-users/kohadocs/commit/635fe37d0c5c6bbae62dde6e26f2002b11be755b

We are now looking for patches to the problems pointed out here:
https://gitlab.com/koha-community-devs-users/kohadocs/blob/20bcd806f7df908b19126eea9fb12359154c0312/en/OUTPUT
Comment 3 Katrin Fischer 2017-09-12 12:52:24 UTC
Hi Pablo, the inter-manual links have been fixed for the upcoming 17.11 manual. Please see the git repository for details.