Repository navigation
Enable link checking with html_proofer (non-automated for now) - #340
Conversation
As discussed in flutter/flutter#7306 and #340
|
|
||
| ``` | ||
| bundle exec jekyll build | ||
| bundle exec htmlproofer --empty-alt-ignore _site --url-ignore "#" |
There was a problem hiding this comment.
shouldn't this happen in the PR test?
Realistically, I'm not going to be installing jekyll and running this before every checkin. I rely on Travis to do these tests.
There was a problem hiding this comment.
This is just the first step, we definitely need something more automated also.
I don't think we should fail a Travis build on this; it's a little too uncontrollable to have the build fail on the availability on some external website. But I plan on enabling daily builds that will check the links using the new Crons feature in Travis. I'm testing that setup for a few days on my fork, and will send a PR for that if it works out.
|
I think we already do cron-based testing for the web site, FWIW. @sethladd might know more. |
|
Yes, we have a Travis cron that runs every day on the web site. |
|
Yes, but we need adjustments to the script (Travis uses the same .yml) for
the cron case. I'm working on those.
Can I get a LGTM on this PR?
…On Dec 30, 2016 06:15, "Adam Barth" ***@***.***> wrote:
Yes, we have a Travis cron that runs every day on the web site.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#340 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/ANAxim-Z6V5HhQXeqV1RAuTCgy7XAwXQks5rNJN6gaJpZM4LXeOg>
.
|
|
I agree with @Hixie that we should just run this check on every PR. If it's too flaky, we can iterate. |
|
Ok, that's easy, but we would need to fix the errors I listed in flutter/flutter#7306 first. Can one of you take a look at those? It looks like they are mostly framework classes that no longer exist (maybe renamed?). |
|
Yes, that page is pretty out-of-date because we revised the part of the system it is describing substantially. |
|
@Hixie @abarth I'd like to land this first PR so we can get manual checking in; can I get a LGTM? Once someone with more knowledge of the Flutter framework fixes flutter/flutter#7306, I'll enable automatic checking (I have it running already on my fork). |
|
Is the issue that this PR title is misleading? The title implies that this PR turns on automated link checking. I can't see where we do that in the Travis process? Perhaps this PR is just about installing/locking new dependencies required by link checking. This PR by itself LGTM but I'd like to try living with link checking turned on for every PR. If life becomes too painful, we can revisit. But let's try with more checking, not less. |
* Fix a few broken links As discussed in flutter/flutter#7306 and #340 * Update debugging.md * Update Observatory URL * Update alt strings These images are merely a graphical representation of the surrounding text, so they can be left empty per §4.8.4.4.6: https://html.spec.whatwg.org/#a-graphical-representation-of-some-of-the-surrounding-text
Inspired by flutter/flutter#7306, we should check all links
This uses https://github.com/gjtorikian/html-proofer.