Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

htmlproofer upgraded major version number #1764

Merged
merged 8 commits into from Jul 16, 2022
Merged

htmlproofer upgraded major version number #1764

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7648e79
Tweak optionss :shrug:
plaindocs Jul 14, 2022
5c219bc
WIP
plaindocs Jul 14, 2022
7bd3040
Need to open an issue for this config?
plaindocs Jul 14, 2022
637ecca
Add link to old flickr to prevent empty link
plaindocs Jul 15, 2022
913bc7e
Ignore this weird little A tag for now
plaindocs Jul 15, 2022
b75f560
Ignore HTTP errors (we should probably bulk replace these)
plaindocs Jul 15, 2022
ec16e27
Fix excessive search and replace
plaindocs Jul 15, 2022
4c836d6
Merge branch 'main' into fix-html-proofer-4
CollierCZ Jul 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
View file
Open in desktop
Expand Up @@ -110,4 +110,4 @@ jobs:

- name: Check links
run: |
htmlproofer --file-ignore "/404/,/2013/,/2014/,/2015/,/2016/,/2017/,/search\/index.html/" --allow-hash-href --internal-domains 'www.writethedocs.org' --alt-ignore '/.*/' --disable-external docs/_build/html
htmlproofer --ignore-files "/404/,/2013/,/2014/,/2015/,/2016/,/2017/,/search\/index.html/" --allow-hash-href --enforce-https=false --ignore-missing-alt --disable-external docs/_build/html
3 changes: 3 additions & 0 deletions docs/_data/config-portland-2018.yaml
View file
Open in desktop
Expand Up @@ -10,6 +10,7 @@ area_adj: North American
tz: PST
email: portland@writethedocs.org


photos:
default: _static/conf/images/headers/group.png

Expand Down Expand Up @@ -54,6 +55,8 @@ about:
You can find out more information about the venue and its accessibility on our :doc:`/conf/portland/2018/venue` page."
location:
"Crystal Ballroom located at 1332 W Burnside St"
photos: https://www.flickr.com/photos/writethedocs/albums/72157695853045204/


cfp:
url: https://docs.google.com/forms/d/e/1FAIpQLSdb-MNRT3TdDTuVIcf-3lZRWDOgguZfjatLr-HLN5ngx5t04w/viewform
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/eu/2016/cfp/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/eu/2016/">
<img src="../../../../_static/img/2016/site-logo.png" />
</a>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Would the error go away if the image had an alt attribute? It seems like it's an empty link for people who don't load images, which isn't ideal for accessibility. Though I doubt there's many people going back to look at the logo from 6 years ago.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah, I was over enthusiastic in my search replace. The ignore there is intended for the bunch of a tags that don't have a reference, like this one: https://github.com/writethedocs/www/pull/1764/files#diff-7a114b4493925c9b9c38c932134ded5be5f69f6f371dec742f42271428f9d96cR45

We don't check for empty or missing alt tags, because we have so many, although I'd definitely be interested in fixing that, at least in current conferences. What is best practice for alt tags for images that don't mean anything and are just part of the theme?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've removed the unnecessary changes, thanks.

Copy link
Collaborator

Choose a reason for hiding this comment

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

For those, an empty alt attribute:

<img src="image.png" alt="" />

That signals that it's just decoration and is intentionally blank

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right, so we have the following two options for htmlproofer:

  p.option 'ignore_empty_alt', '--ignore-empty-alt', ' If `true`, ignores images with empty/missing alt tags (in other words, `<img alt>` and `<img alt="">` are valid; set this to `false` to flag those)'
  p.option 'ignore_missing_alt', '--ignore-missing-alt', 'If `true`, ignores images with missing alt tags'

And we could run htmlproofer multiple times, for example ignoring alts on everything before 2022, and another not ignoring alts but allowing empty on 2022...

The place to start there would be in docs/_templates/2022/*

Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/eu/2016/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/eu/2016/">
<img src="../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/eu/2016/lightning-talks/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/eu/2016/">
<img src="../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/eu/2016/news/announce-presentations/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/eu/2016/">
<img src="../../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/eu/2016/news/cfp-new-deadline/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/eu/2016/">
<img src="../../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/eu/2016/news/cfp-tickets/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/eu/2016/">
<img src="../../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/eu/2016/news/code-of-conduct-report/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/eu/2016/">
<img src="../../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/eu/2016/news/day-of/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/eu/2016/">
<img src="../../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/eu/2016/news/schedule/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/eu/2016/">
<img src="../../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/eu/2016/news/thanks-for-coming/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/eu/2016/">
<img src="../../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/eu/2016/news/videos-coc-report/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/eu/2016/">
<img src="../../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/eu/2016/news/welcome/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/eu/2016/">
<img src="../../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/eu/2016/schedule/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/eu/2016/">
<img src="../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/eu/2016/speakers/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/eu/2016/">
<img src="../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/eu/2016/unconference/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/eu/2016/">
<img src="../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/eu/2016/visiting/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/eu/2016/">
<img src="../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/eu/2016/writingday/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/eu/2016/">
<img src="../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/cfp/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/hike/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/lightning-talks/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/news/announcing-2016/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/news/announcing-presentations/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/news/cfp-reminder/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/news/cfp-tickets/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/news/schedule-welcome-wagon-events/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/news/thanks-for-coming/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/news/welcome/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/schedule/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/speakers/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/unconference/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/venue/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/visiting/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/welcome-wagon/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_static_html/conf/na/2016/writing-day/index.html
View file
Open in desktop
Expand Up @@ -114,7 +114,7 @@


<div class="hero hero-conf">
<div class="hero-logo">
<div class="hero-logo" data-proofer-ignore>
<a href="/conf/na/2016/">
<img src="../../../../_static/img/2016/site-logo.png" />
</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/2018/index.html
View file
Open in desktop
Expand Up @@ -42,7 +42,7 @@

<div class="hero-content uk-container">
<div class="logo-container">
<a class="hero-logo">
<a class="hero-logo" data-proofer-ignore>
Write<br/>
the<br/>
Docs<br/>
Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/2019/index.html
View file
Open in desktop
Expand Up @@ -42,7 +42,7 @@

<div class="hero-content uk-container">
<div class="logo-container">
<a class="hero-logo">
<a class="hero-logo" data-proofer-ignore>
Write<br/>
the<br/>
Docs<br/>
Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/2020/index.html
View file
Open in desktop
Expand Up @@ -42,7 +42,7 @@

<div class="hero-content uk-container">
<div class="logo-container">
<a class="hero-logo">
<a class="hero-logo" data-proofer-ignore>
Write<br/>
the<br/>
Docs<br/>
Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/2021/index.html
View file
Open in desktop
Expand Up @@ -43,7 +43,7 @@

<div class="hero-content uk-container">
<div class="logo-container">
<a class="hero-logo">
<a class="hero-logo" data-proofer-ignore>
Write<br/>
the<br/>
Docs<br/>
Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/2022/index.html
View file
Open in desktop
Expand Up @@ -43,7 +43,7 @@

<div class="hero-content uk-container">
<div class="logo-container">
<a class="hero-logo">
<a class="hero-logo" data-proofer-ignore>
Write<br/>
the<br/>
Docs<br/>
Expand Down