[ovirt-devel] [rhevm-staff] oVirt website hackathon

[Maor Lipchuk]

On Sun, Sep 24, 2017 at 10:38 PM, Tomáš Golembiovský
<tgolembi at redhat.com> wrote:
> On Sun, 24 Sep 2017 17:51:50 +0300
> Eyal Edri <eedri at redhat.com> wrote:
>
>> On Sun, Sep 24, 2017 at 4:52 PM, Eyal Edri <eedri at redhat.com> wrote:
>>
>> >
>> > On Sun, Sep 24, 2017 at 4:48 PM, Eyal Edri <eedri at redhat.com> wrote:
>> >
>> >> Hi,
>> >>
>> >> So I've found linkchecker[1], which is quite a powerful and useful tool
>> >> for that, and run it on oVirt.org, the results are not good, unfortunately.
>> >> We have over 15K(!) of broken links to fix before we can even consider
>> >> adding a constant CI job to check new commits.
>
> How about checking that no *new* broken links are introduced by pull
> requests? Would that be easy enough to do?
>
>
>> >>
>> >> Snippet example from the huge report attached to this email [2]. ( btw
>> >> there are other formats available to generate this report if we want )
>> >>
>> >
>> > resending with zipped report ( the file was 16MB, too big for the list ).
>> >
>>
>> I've rerun the tool excluding .png images, since there are many of them and
>> the broken links got down to 2373, to much more reasonable number
>> to start working on.
>
> 2k is "reasonable"? Really? :)
>
>
>> Attached new report w/o images.
>>
>>
>> >
>> >
>> >>
>> >> After we'll do an initial cleanup of the broken links ( similar to what
>> >> we did on findbugs errors ), we can consider adding CI for it, 2 ideas I
>> >> had in mind:
>> >>
>> >>
>> >> 1. Running the tool on GitHub PR using Travis CI ( which ovirt-site is
>> >> already connected to it ), the tool seems to be using it as well for
>> >> testing itself
>> >> 2. Adding ovirt-site as a std-ci project and using it to also properly
>> >> deploy to the site in the end ( more complex and long term goal, which
>> >> might require more work ).
>> >>
>> >>
>> >> TL;DR, let's schedule a doc-fix day first to address the sheer amount of
>> >> broken links and then worry about adding CI.
>> >>
>> >>
>> >>
>> >> [1] https://github.com/wummel/linkchecker
>> >> [2]
>> >>
>> >> URL `develop/release-management/features/sla/hosted-engine-agent
>> >> -offloading/#documentation'
>> >> Name `Documentation/External references'
>> >> Parent URL https://ovirt.org/develop/release-management/features/sla/
>> >> hosted-engine-agent-offloading/, line 1870, col 131 (HTML
>> >> <http://validator.w3.org/check?ss=1&uri=https://ovirt.org/develop/release-management/features/sla/hosted-engine-agent-offloading/>)
>> >> (CSS
>> >> <http://jigsaw.w3.org/css-validator/validator?uri=https://ovirt.org/develop/release-management/features/sla/hosted-engine-agent-offloading/&warning=1&profile=css2&usermedium=all>
>> >> )
>> >> Real URL https://ovirt.org/develop/release-management/features/sla/
>> >> hosted-engine-agent-offloading/develop/release-management/
>> >> features/sla/hosted-engine-agent-offloading/#documentation
>> >> Size 14.63KB
>> >> Check time 3.496 seconds
>> >> Result Error: 404 Not Found
>> >>
>> >>
>> >> URL `/images/apple-touch-icon-precomposed.png'
>> >> Parent URL https://www.ovirt.org, line 22, col 1 (HTML
>> >> <http://validator.w3.org/check?ss=1&uri=https://www.ovirt.org>) (CSS
>> >> <http://jigsaw.w3.org/css-validator/validator?uri=https://www.ovirt.org&warning=1&profile=css2&usermedium=all>
>> >> )
>> >> Real URL https://www.ovirt.org/images/apple-touch-icon-precomposed.png
>> >> Size 14.63KB
>> >> Check time 1.851 seconds
>> >> Result Error: 404 Not Found
>> >>
>> >>
>> >
>> > --
>> >
>> > Eyal edri
>> >
>> >
>> > ASSOCIATE MANAGER
>> >
>> > RHV DevOps
>> >
>> > EMEA VIRTUALIZATION R&D
>> >
>> >
>> > Red Hat EMEA <https://www.redhat.com/>
>> > <https://red.ht/sig> TRIED. TESTED. TRUSTED. <https://redhat.com/trusted>
>> > phone: +972-9-7692018 <+972%209-769-2018>
>> > irc: eedri (on #tlv #rhev-dev #rhev-integ)
>> >
>>
>>
>>
>> --
>>
>> Eyal edri
>>
>>
>> ASSOCIATE MANAGER
>>
>> RHV DevOps
>>
>> EMEA VIRTUALIZATION R&D
>>
>>
>> Red Hat EMEA <https://www.redhat.com/>
>> <https://red.ht/sig> TRIED. TESTED. TRUSTED. <https://redhat.com/trusted>
>> phone: +972-9-7692018
>> irc: eedri (on #tlv #rhev-dev #rhev-integ)
>
>
> --
> Tomáš Golembiovský <tgolembi at redhat.com>
> _______________________________________________
> Devel mailing list
> Devel at ovirt.org
> http://lists.ovirt.org/mailman/listinfo/devel


Nice!
It reminds me that Daniel and I developed a similar tool last year
(see [1]) which adds the ability of sending an email to the author
which committed the broken link, based on the git repository.
Maybe it can save you some time on fixing all of the broken links and
instead let the committers do it.

[1] https://github.com/chipchaderez/Wiki-Link-Validator

Regards,
Maor