Error “internally linking to , which does not exist” about html-proofer

[doktorbro]

I judged too fast. Everything works as expected. We should improve the message anyway.

[lurch]

More details:
I had expected the directory_index_file option to fix the "./_build/linux/usage/commands.md: internally linking to ../../remote-access/ssh/, which does not exist" error of https://travis-ci.org/raspberrypi/documentation/builds/33684029 since linux/usage/commands.md indeed has a link like [SSH (secure shell)](../../remote-access/ssh/)
(which is why my commit-comment was "Attempt to fix one of the Travis build errors")

But I was very surprised that it also fixed the "./_build/configuration/raspi-config.md: internally linking to , which does not exist" errors, which seem to be caused by e.g. <a name="usage"></a> (configuration/raspi-config.md contains 19 named anchors, and the "raspi-config.md: internally linking to ," error appears 19 times).

Perhaps adding the directory_index_file option somehow 'masks' the named-anchor bug? (obviously if linux/usage/commands.md had instead linked directly to ../../remote-access/ssh/README.md I would never have added that option in the first place!)

[doktorbro]

@lurch The use of the name attribute for anchors is deprecated. You should use the id attribute. Can you switch to id and try again?

[lurch]

Unlikely to happen - it's the 'recommended' way of doing it according to https://github.com/raspberrypilearning/creating-resources/blob/master/markdown.md#anchors
They may be 'deprecated' but they're used all over the place on both https://github.com/raspberrypi/documentation and on https://github.com/raspberrypilearning/

You're welcome to raise it as an issue at https://github.com/raspberrypi/documentation/issues but given the amount of documentation and resources that have already been written you'd be unlikely to get very far IMHO.

[doktorbro]

@lurch Thank you for the great report. The placeholder issue should be fixed in #107.

[lurch]

That's great to hear :)
Just out of curiosity, did you manage to figure out how / why enabling directory_index_file masked the named-anchor errors?

[doktorbro]

@lurch No, I had no time for deeper analysis.

[lurch]

Thanks for fixing the issues so promptly!
Let me know when the next version of html-proofer is released, and I can force a Travis-rebuild of raspberrypi/documentation to check that it still works with the new version :)

[gjtorikian]

It's bumped now to 1.3.3.

[lurch]

A forced-rebuild of https://travis-ci.org/raspberrypi/documentation/builds/33774245 works absolutely fine with html-proofer 1.3.3 :-)

[gjtorikian]

Phew, glad it worked!

Also: super stoked RaspberryPi is using this: https://twitter.com/gjtorikian/status/494546083666604032

[doktorbro]

Fantastic.

[envygeeks]

I get this problem when the link doesn't have a "/" at the end to a full domain. I don't think that's how it should work, unless I am missing something, but since the browser handles that problem, it shouldn't be enforced.

[envygeeks]

The reason I think it shouldn't work this way is because the only way to normalize URL's is with Ruby (in Jekyll) and of course I can in my own plugin, but within another authors plugin this becomes a PITA see:

- site/2013/06/24/mocking-activerecord-to-test-concerns.html
  *  internally linking to https://envygeeks.io//, which does not exist (line 79)
     <a href="https://envygeeks.io//">Jordon Bedwell</a>

    <p class="author">
      <a href="{{ post.stat.author.website }}/">
        {{ post.stat.author.name }}
      </a>
    </p>

It becomes even more strenuous when dealing with data from another domain.

[envygeeks]

To add, I guess this could be a mixture of internal_domains and otherwise.