LibreCat / Catmandu

Catmandu - a data processing toolkit
https://librecat.org
175 stars 31 forks source link

documentation links are broken #394

Closed VladimirAlexiev closed 2 years ago

VladimirAlexiev commented 2 years ago

Doc links (eg in http://librecat.org/Catmandu/#import) are rendered as anchors rather than external links (eg http://librecat.org/Catmandu/#-https://metacpan.org/pod/catmandu::store::mongodb), and therefore are broken.

The links use somewhat unusual markdown link location:

[[MongoDB | https://metacpan.org/pod/Catmandu::Store::MongoDB]]

Whereas the usual notation looks like this:

[MongoDB](https://metacpan.org/pod/Catmandu::Store::MongoDB)

However, I checked with the Preview of github's online editor (eg https://github.com/LibreCat/Catmandu/wiki/command-line-client/_edit) and both of the above links work as expected.

Therefore, somethink in the process of rendering Github wiki pages as HTML, breaks these external links.

Cheers!

vpeil commented 2 years ago

I'd willing to correct all of these.

@phochste @nichtich who remembers how this documentation is generated?

phochste commented 2 years ago

The text is from the wiki in this Catmandu project. The website is generated using the https://github.com/LibreCat/librecat.github.io project

vpeil commented 2 years ago

I have updated the links in the wiki. Unfortunately, I didn't manage to update the documentation on the librecat website. @phochste can you help, please?

nichtich commented 2 years ago

I've updated the homepage and slightly simplified the update process, see https://github.com/LibreCat/librecat.github.io#deployment

vpeil commented 2 years ago

Thanks @nichtich