Introduce docs on adding new facades #119

paulirish · 2020-11-12T23:02:31Z

to clear on authorship: @adamraine wrote most of this. I revised it and yote it over here.

ref GoogleChrome/lighthouse#11290

paulirish · 2020-11-12T23:16:13Z

@addyosmani .. me patrick and adam revised this a bit and i brought it over here. holla if you have suggestions.

patrickhulce

meat of this looks fantastic 👌

facades.md

patrickhulce · 2020-11-13T02:37:12Z

facades.md

@@ -0,0 +1,58 @@
+# Adding a new facade to third-party-web
+
+Lighthouse 7.0 includes a new audit to flag third-party 


this paragraph feels like it might belong in lighthouse or web.dev pointing to this doc?

here it feels like just a sentence saying this powers lighthouse would work

sure. i tweaked it.

since we're spread across LH report, web.dev docs, this doc, etc.. I still want a little bit of context everywhere. it's redundant but whatever.

facades.md

Co-authored-by: Patrick Hulce <[email protected]>

facades.md

adamraine

Overall LGTM, thanks for for the help refining this!

adamraine · 2020-11-13T23:21:52Z

facades.md

@@ -0,0 +1,58 @@
+# Facade data in third-party-web
+
+In addition to identifying entities and products, third-party-web also includes data on available alternative libraries for products known as _facades_. A _facade_ is a static element which looks similar to the actual embedded resource, but is not functional and therefore much less taxing on the page load.


Defining "facade" here seems redundant since we have the terminology section below.

agree. @patrickhulce cool if we drop it here? or we just inline the terminology into sentences up here.

inline up here SGTM. I wanted an intro to the purpose of this document for the rest of the community and contributors that wasn't "Lighthouse has a new audit" :)

terminology section was helpful for broad context google doc, but can just be in intro here SGTM

facades.md

Co-authored-by: Patrick Hulce <[email protected]>

Co-authored-by: Adam Raine <[email protected]>

patrickhulce

thanks a lot for working this up @adamraine and @paulirish !

facades.md

addyosmani · 2020-11-21T22:33:39Z

facades.md

+## Criteria for adding a new facade
+### Basic functionality
+
+* Loads an HTML component on page load which looks like the actual third-party 


Imo, a facade should present an approximate of the actual third-party, but it doesn't strictly need to load an HTML component to do this. It's valid if you have an image/screenshot/generated scrape of the 3P that loads the real thing on interaction.

Something like https://twitter.com/wongmjane/status/1330273157245243394 is an example of where an image can be fine here.

Isn't your example an HTML component?

I interpreted "HTML component" here to mean anything that shows up in the DOM as compared to a library/utility that only exists in JS.

yeah i was going with a loose definition of "component". There doesn't feel like there's a great word for this thing. It's not a "library".... even "widget" is close but doesn't feel right.

Patrick: after taking a second look, you're of course correct. I know finding the right wording here is tricky and so HTML component may be totally fine if its to be interpreted with a loose definition.

If it took this conversation to explain thats what we're talking about to someone already very familiar with the area though, perhaps thats enough of a signal that others might not understand what we're talking about :)

Is there an alternative term you had in mind @addyosmani that has a better blend of the generic yet specific we need here?

addyosmani · 2020-11-21T22:34:45Z

facades.md

+
+### Well Maintained
+
+* The projects issues and contributions are managed responsibly. Bugs are 


Minor: Is there any concern we aren't defining what we mean by swiftly here? e.g perhaps we could provide an example (swiftly (e.g within 30-60 days of filing)).

I think we were intentionally vague on these points, @paulirish and I had quite the scuffle as to whether it's better to have these discussions on a case-by-case basis or a settled policy ;)

yeah i just thinking we may be adding more governance than necessary. but swiftly (e.g within 30-60 days of filing) wfm.

addyosmani · 2020-11-21T22:35:50Z

facades.md

+
+* The projects issues and contributions are managed responsibly. Bugs are 
+  handled swiftly.
+* Is already used in production, ideally by users other than the creator.


Would this requirement disqualify some of the options we were looking to recommend earlier? e.g Alex's vimeo lite component. I'm not saying this shouldn't be a recommendation (rather, I think production use is a great requirement), just pointing this out... :)

I think it would disqualify many, but I think that's why they're guidelines w/case-by-case determination instead of strict requirements and the intention was just to not broadcast that.

addyosmani · 2020-11-21T22:36:31Z

facades.md

+
+Read 
+[contributing](https://github.com/patrickhulce/third-party-web#contributing) for 
+basics; look in `data/entities.js` for `products` to see how the data is structured.


Rest of this looks great 👍

Co-authored-by: Patrick Hulce <[email protected]>

adamraine · 2020-12-01T19:18:02Z

Hasn't been movement here in a bit. Any objections to merging?

patrickhulce · 2020-12-01T20:31:13Z

thanks for the reminder @adamraine, done :)

Introduce docs on adding new facades

de4e085

paulirish requested review from patrickhulce and adamraine November 12, 2020 23:02

paulirish added 3 commits November 12, 2020 15:06

Update facades.md

7663967

Update facades.md

b96a054

Update facades.md

8e92de5

patrickhulce reviewed Nov 13, 2020

View reviewed changes

patrickhulce self-assigned this Nov 13, 2020

adamraine reviewed Nov 13, 2020

View reviewed changes

facades.md Outdated Show resolved Hide resolved

patrickhulce and others added 4 commits November 13, 2020 11:21

Update facades.md

338b905

Apply suggestions from code review

ebf1e6c

Update facades.md

d5c150b

Co-authored-by: Patrick Hulce <[email protected]>

Update facades.md

7437e22

patrickhulce approved these changes Nov 13, 2020

View reviewed changes

facades.md Outdated Show resolved Hide resolved

adamraine reviewed Nov 13, 2020

View reviewed changes

paulirish and others added 3 commits November 13, 2020 16:00

Update facades.md

e6b7faf

Co-authored-by: Patrick Hulce <[email protected]>

Update facades.md

97855de

Co-authored-by: Adam Raine <[email protected]>

inline to the toppppp

026ff84

patrickhulce approved these changes Nov 14, 2020

View reviewed changes

facades.md Outdated Show resolved Hide resolved

adamraine mentioned this pull request Nov 17, 2020

Need criteria and process for adding facades to web.dev documentation GoogleChrome/lighthouse#11583

Closed

addyosmani reviewed Nov 21, 2020

View reviewed changes

paulirish and others added 3 commits November 21, 2020 15:27

Update facades.md

6baf121

Co-authored-by: Patrick Hulce <[email protected]>

Update facades.md

7141bab

Update facades.md

10ec0f8

patrickhulce merged commit 5adb9bd into master Dec 1, 2020

patrickhulce deleted the paulirish-patch-1 branch December 1, 2020 20:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce docs on adding new facades #119

Introduce docs on adding new facades #119

paulirish commented Nov 12, 2020 •

edited

Loading

paulirish commented Nov 12, 2020

patrickhulce left a comment

patrickhulce Nov 13, 2020

paulirish Nov 13, 2020

adamraine left a comment

adamraine Nov 13, 2020

paulirish Nov 14, 2020

patrickhulce Nov 14, 2020 •

edited

Loading

patrickhulce left a comment

addyosmani Nov 21, 2020

patrickhulce Nov 21, 2020

paulirish Nov 21, 2020

addyosmani Nov 23, 2020

patrickhulce Nov 24, 2020

addyosmani Nov 21, 2020

patrickhulce Nov 21, 2020

paulirish Nov 21, 2020

addyosmani Nov 21, 2020

patrickhulce Nov 21, 2020

addyosmani Nov 21, 2020

adamraine commented Dec 1, 2020

patrickhulce commented Dec 1, 2020

		@@ -0,0 +1,58 @@
		# Adding a new facade to third-party-web

		Lighthouse 7.0 includes a new audit to flag third-party

		@@ -0,0 +1,58 @@
		# Facade data in third-party-web

		In addition to identifying entities and products, third-party-web also includes data on available alternative libraries for products known as _facades_. A _facade_ is a static element which looks similar to the actual embedded resource, but is not functional and therefore much less taxing on the page load.


		### Well Maintained

		* The projects issues and contributions are managed responsibly. Bugs are

Introduce docs on adding new facades #119

Introduce docs on adding new facades #119

Conversation

paulirish commented Nov 12, 2020 • edited Loading

paulirish commented Nov 12, 2020

patrickhulce left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamraine left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

patrickhulce Nov 14, 2020 • edited Loading

Choose a reason for hiding this comment

patrickhulce left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamraine commented Dec 1, 2020

patrickhulce commented Dec 1, 2020

paulirish commented Nov 12, 2020 •

edited

Loading

patrickhulce Nov 14, 2020 •

edited

Loading