Skip to content

Enable link checking with html_proofer (non-automated for now) - #340

Merged
mit-mit merged 4 commits into
flutter:masterfrom
mit-mit:master
Jan 5, 2017
Merged

mit-mit merged 4 commits into
flutter:masterfrom
mit-mit:master

Conversation

@mit-mit

@mit-mit mit-mit commented Dec 29, 2016

Copy link
Copy Markdown
Member

Inspired by flutter/flutter#7306, we should check all links

This uses https://github.com/gjtorikian/html-proofer.

@googlebot googlebot added the cla: yes Contributor has signed the Contributor License Agreement label Dec 29, 2016
mit-mit added a commit that referenced this pull request Dec 29, 2016
@mit-mit mit-mit mentioned this pull request Dec 29, 2016
Comment thread README.md

```
bundle exec jekyll build
bundle exec htmlproofer --empty-alt-ignore _site --url-ignore "#"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@Hixie

Hixie commented Dec 29, 2016

Copy link
Copy Markdown
Contributor

I think we already do cron-based testing for the web site, FWIW. @sethladd might know more.

@abarth

abarth commented Dec 30, 2016

Copy link
Copy Markdown
Contributor

Yes, we have a Travis cron that runs every day on the web site.

@mit-mit

mit-mit commented Dec 30, 2016 via email

Copy link
Copy Markdown
Member Author

@abarth

abarth commented Dec 30, 2016

Copy link
Copy Markdown
Contributor

I agree with @Hixie that we should just run this check on every PR. If it's too flaky, we can iterate.

@mit-mit

mit-mit commented Dec 30, 2016

Copy link
Copy Markdown
Member Author

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?).

@abarth

abarth commented Dec 30, 2016

Copy link
Copy Markdown
Contributor

Yes, that page is pretty out-of-date because we revised the part of the system it is describing substantially.

@mit-mit

mit-mit commented Jan 4, 2017

Copy link
Copy Markdown
Member Author

@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).

@sethladd

sethladd commented Jan 5, 2017

Copy link
Copy Markdown
Contributor

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.

mit-mit added a commit that referenced this pull request Jan 5, 2017
* 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
@mit-mit mit-mit changed the title Enable automated link checking Enable link checking with html_proofer (non-automated for now) Jan 5, 2017
@mit-mit
mit-mit merged commit e9ea5da into flutter:master Jan 5, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla: yes Contributor has signed the Contributor License Agreement

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants