2020 Resource Hints chapter #1587

Zizzamia · 2020-11-28T02:15:53Z

In this PR we introduce the first official draft as markdown for the Resource Hints 2020 chapter #920.

Following PRs will focus on:

polishing figures
review all backlinks
possible final editing

Thank you @rviscomi and @OBTo for all the guidance, and all reviewers and analysts (@notwillk, @giopunt, @jessnicolet, @pmeenan, @mgechev) for the incredible feedbacks and help. 🙏
Please, feel free to keep mentioning anything in terms of content or data we might want to polish, I am going to use the next few days to do several final clean-up anyway. 🌲 🚀 🌕

rviscomi

One quick suggestion to get the build working

I've staged the draft here to assist with the review: https://20201127t212713-dot-webalmanac.uk.r.appspot.com/en/2020/resource-hints

src/content/en/2020/resource-hints.md

tunetheweb · 2020-11-28T14:53:14Z

Looks good to me @Zizzamia but difficult to be sure until we see the charts in place. I would normally advocate for smaller PRs and an iterative approach but, since the chapter isn't actually launch-able without the charts I think we should change this to a Draft PR, and then hold it open until the charts are added and the TODOs are finished out.

BTW, just a heads up, after we merge this, there will be a round of editing from someone outside the immediate team (@rviscomi or myself most likely unless we can get some more volunteer Editors) 😁 to try to bring a consistent style and voice across all the chapters. This can be substantial just to warn you as some Authors are surprised with the level of editing. You'll will be asked to review all suggested edits to make sure you are comfortable with them.

It is possible to launch the chapter with an unedited tag (see the 2020 Markup Chapter as an example), but that is the minimal viable product of the chapter so do really need the images to get to that:

rviscomi · 2020-11-28T17:45:05Z

src/content/en/2020/resource-hints.md

 reviewers: [notwillk, giopunt, jessnicolet, pmeenan, mgechev]
 analysts: [khempenius]


Can you verify that all of these reviewers/analysts have meaningfully contributed to the chapter and are roughly in sorted order so that the biggest contributors are listed first?

src/content/en/2020/resource-hints.md

Co-authored-by: Rick Viscomi <[email protected]>

Zizzamia · 2020-11-28T23:51:06Z

@bazzadp thank you for the initial push-back, with @rviscomi we added the charts into this PRs. Also we were able to update the order of reviewers based on the amount of contributions and added all the correct gid and sql values into the figures.

If it's ok for the team I will follow up with more polishing figures, backlinks review and possible final editing in the next PRs.

And yeah, looking forward from all editors to review and re-shape the article in a way it's more aligned with the rest of the Almanac 2020. 🌲🌕🌲

tunetheweb

Very well done @Zizzamia ! Great chapter and I enjoyed reading that.

I do have some comments for you to consider though.

tunetheweb · 2020-11-29T23:16:58Z

src/content/en/2020/resource-hints.md

@@ -5,19 +5,367 @@ chapter_number: 21
 title: Resource Hints
 description: Resource Hints chapter of the 2020 Web Almanac covering usage of dns-prefetch, preconnect, preload, prefetch, priority hints, and native lazy loading.
 authors: [Zizzamia]
-reviewers: [notwillk, giopunt, jessnicolet, pmeenan, mgechev]
+reviewers: [jessnicolet, pmeenan, giopunt, mgechev, notwillk]


@notwillk can you add yourself to the 2020,json config so you will render properly?

It looks like I'm in there (name is wrong). Is up dating my name all I need to do there?

Ah yes I saw this:

And presumed you were in there. If you could add your full name (and any other details you want to show in the Contributors page) that would be great.

src/content/en/2020/resource-hints.md

tunetheweb · 2020-11-30T00:17:06Z

src/content/en/2020/resource-hints.md

+{{ figure_markup(
+  caption="Percentage of pages using native lazy loading set to “lazy”",
+  content="3.87%",
+  classes="big-number",
+  sheets_gid="2039808014",
+  sql_file="native_lazy_loading_attrs.sql"
+) }}


Is this images or images and iframes? Think it would be good to clarify (applies to this whole section). And if just images should we have a sentence or two on iframes? We use it on our site :-)

src/content/en/2020/resource-hints.md

tunetheweb · 2020-11-30T00:54:10Z

Oh and one more comment, there do seem to be an awful lot of the big callout figures in this chapter. Very much like resource hints, over use can diminish the impact of all of them 😁 Could we replace any with charts or tables?

Co-authored-by: Barry Pollard <[email protected]>

Zizzamia · 2020-12-01T01:36:16Z

@bazzadp thank you for reviewing, and yeah I would love to replace a few figures with tables and even add a bit more code examples. Would you like I made all future changes in this PR on in the next one (including a few comments you left as well)?

rviscomi · 2020-12-01T02:12:40Z

I'd like to see us merge and iterate to unblock the editing step. If there's anything else that needs to be changed please leave TODO's in the markdown and resolve as suggestions in the editing PR itself, or a follow-up PR.

tunetheweb · 2020-12-01T06:51:37Z

I'd like to see us merge and iterate to unblock the editing step. If there's anything else that needs to be changed please leave TODO's in the markdown and resolve as suggestions in the editing PR itself, or a follow-up PR.

Agreed. @Zizzamia could you have one last pass through all the open comments and either resolve them or add a Jinja2 comment (using {# and #}), which won't show up in the final HTML. Something like this:

{# TODO - clarify img versus img in this section - Ref https://github.com/HTTPArchive/almanac.httparchive.org/pull/1587#discussion_r532292106 #}

We can then edit this chapter and come back to these few remaining points later.

Co-authored-by: Barry Pollard <[email protected]>

…chive/almanac.httparchive.org into zizzamia/init-resource-hints-2020

Co-authored-by: Barry Pollard <[email protected]>

…chive/almanac.httparchive.org into zizzamia/init-resource-hints-2020

Zizzamia · 2020-12-02T04:15:08Z

Todos in place, I'm going to work on them in the next PR 🌲🚀🌕
cc @rviscomi @bazzadp

rviscomi · 2020-12-02T04:23:49Z

Ok great!

docs: Init Resource Hints 2020 chapter

06d7b8c

Zizzamia requested a review from rviscomi November 28, 2020 02:16

rviscomi added the writing Related to wording and content label Nov 28, 2020

rviscomi added this to the 2020 Content Writing milestone Nov 28, 2020

rviscomi requested a review from a team November 28, 2020 02:17

rviscomi requested changes Nov 28, 2020

View reviewed changes

src/content/en/2020/resource-hints.md Outdated Show resolved Hide resolved

Zizzamia added 2 commits November 27, 2020 22:10

fix: quotes

523a622

fix: quotes inside figure_markup

e457a3a

rviscomi changed the title ~~docs: Init Resource Hints 2020 chapter~~ Resource Hints 2020 chapter Nov 28, 2020

rviscomi requested changes Nov 28, 2020

View reviewed changes

Zizzamia and others added 6 commits November 28, 2020 15:15

fix: added chart 1

45499a8

Co-authored-by: Rick Viscomi <[email protected]>

fix: added chart 2

d57029f

Co-authored-by: Rick Viscomi <[email protected]>

fix: gid

bfde7aa

Co-authored-by: Rick Viscomi <[email protected]>

fix: added chart 3

5b6a4fe

Co-authored-by: Rick Viscomi <[email protected]>

fix: added chart 4

e02df75

Co-authored-by: Rick Viscomi <[email protected]>

fix: reviewers order and gid/sql references

94db833

tunetheweb changed the title ~~Resource Hints 2020 chapter~~ 2020 Resource Hints chapter Nov 29, 2020

tunetheweb requested changes Nov 30, 2020

View reviewed changes

Zizzamia and others added 7 commits November 29, 2020 17:59

fix: added link to coinbase text

d14435d

Co-authored-by: Barry Pollard <[email protected]>

fix: lowercase "resource hints"

3bc5417

Co-authored-by: Barry Pollard <[email protected]>

fix: code format

5456616

Co-authored-by: Barry Pollard <[email protected]>

fix: combined similar url

c2e3d0b

Co-authored-by: Barry Pollard <[email protected]>

fix: added link to uses-rel-preconnect

91817f5

Co-authored-by: Barry Pollard <[email protected]>

fix: link between almanac pages

19d1e90

Co-authored-by: Barry Pollard <[email protected]>

fix: tags

a38ef4a

Co-authored-by: Barry Pollard <[email protected]>

Zizzamia and others added 11 commits November 30, 2020 16:40

fix: text CPU and network resources

e784da8

Co-authored-by: Barry Pollard <[email protected]>

fix: polished hints adoption text

642f205

Co-authored-by: Barry Pollard <[email protected]>

fix: dns-prefetch vs preload

f29d498

Co-authored-by: Barry Pollard <[email protected]>

fix: code formatting

99973a8

Co-authored-by: Barry Pollard <[email protected]>

fix: code formatting

5bd2977

Co-authored-by: Barry Pollard <[email protected]>

fix: code formatting

15d03ad

Co-authored-by: Barry Pollard <[email protected]>

fix: code formatting

1e9a6fc

Co-authored-by: Barry Pollard <[email protected]>

fix: changed ML title

4dc0041

Co-authored-by: Barry Pollard <[email protected]>

fix: http/2 push text

aecdce7

Co-authored-by: Barry Pollard <[email protected]>

fix: more context in HTTP/2 text

37209ee

Co-authored-by: Barry Pollard <[email protected]>

fix: link Fastly blog

eacea96

Co-authored-by: Barry Pollard <[email protected]>

rviscomi assigned Zizzamia Dec 1, 2020

tunetheweb mentioned this pull request Dec 1, 2020

Edit 2020 Chapters #1432

Closed

22 tasks

Zizzamia and others added 7 commits December 1, 2020 20:01

fix: critical rendering text

ea98e3c

Co-authored-by: Barry Pollard <[email protected]>

chore: added todos

0ca5925

Merge branch 'zizzamia/init-resource-hints-2020' of github.com:HTTPAr…

5fba5cf

…chive/almanac.httparchive.org into zizzamia/init-resource-hints-2020

fix: such as

cf1fe70

fix: media query text

8306c43

Co-authored-by: Barry Pollard <[email protected]>

chore: more tods

6a17fb8

Merge branch 'zizzamia/init-resource-hints-2020' of github.com:HTTPAr…

2c524de

…chive/almanac.httparchive.org into zizzamia/init-resource-hints-2020

rviscomi merged commit d7f532a into main Dec 2, 2020

rviscomi deleted the zizzamia/init-resource-hints-2020 branch December 2, 2020 04:23

Zizzamia mentioned this pull request Dec 8, 2020

Resource Hints 2020 edits #1664

Merged

24 tasks

tunetheweb mentioned this pull request Jan 3, 2021

Markup 2020 additional edits #1858

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

2020 Resource Hints chapter #1587

2020 Resource Hints chapter #1587

Zizzamia commented Nov 28, 2020 •

edited

Loading

rviscomi left a comment

tunetheweb commented Nov 28, 2020 •

edited

Loading

rviscomi Nov 28, 2020

Zizzamia commented Nov 28, 2020

tunetheweb left a comment

tunetheweb Nov 29, 2020

notwillk Nov 30, 2020

tunetheweb Nov 30, 2020

tunetheweb Nov 30, 2020

tunetheweb commented Nov 30, 2020

Zizzamia commented Dec 1, 2020

rviscomi commented Dec 1, 2020

tunetheweb commented Dec 1, 2020

Zizzamia commented Dec 2, 2020

rviscomi commented Dec 2, 2020

		reviewers: [notwillk, giopunt, jessnicolet, pmeenan, mgechev]
		analysts: [khempenius]

2020 Resource Hints chapter #1587

2020 Resource Hints chapter #1587

Conversation

Zizzamia commented Nov 28, 2020 • edited Loading

rviscomi left a comment

Choose a reason for hiding this comment

tunetheweb commented Nov 28, 2020 • edited Loading

rviscomi Nov 28, 2020

Choose a reason for hiding this comment

Zizzamia commented Nov 28, 2020

tunetheweb left a comment

Choose a reason for hiding this comment

tunetheweb Nov 29, 2020

Choose a reason for hiding this comment

notwillk Nov 30, 2020

Choose a reason for hiding this comment

tunetheweb Nov 30, 2020

Choose a reason for hiding this comment

tunetheweb Nov 30, 2020

Choose a reason for hiding this comment

tunetheweb commented Nov 30, 2020

Zizzamia commented Dec 1, 2020

rviscomi commented Dec 1, 2020

tunetheweb commented Dec 1, 2020

Zizzamia commented Dec 2, 2020

rviscomi commented Dec 2, 2020

Zizzamia commented Nov 28, 2020 •

edited

Loading

tunetheweb commented Nov 28, 2020 •

edited

Loading