-
-
Notifications
You must be signed in to change notification settings - Fork 225
feat(insights): asset module documentation #1306
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right on! A bunch of nits only, overall makes sense 👍🏻
|
||
The description of an asset span should be the full URL which is was fetched from, e.g. `https://cdn.com/main.hash123.js`. | ||
|
||
### Span Data |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section should link to the "Span Data Conventions" section for resources. That way you don't have to re-do the table. You just need to explain which of those attribute are mandatory (all of them?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤔 There is no "resource" section in span data conventions. Resource spans contains some properties from the browser section and some properties from the http section
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, what's the meaning of required here, technically the UI will work with only encoded body size
passed in, although not all data will be populated in the UI.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, I think you should add a section, then, or at least somehow clarify what's going on. As for "meaning of required" that's the question, because it's this document's job to explain that, in detail! e.g., in "Requests" I explain which span attribute is required for which part of the UI. I think you can do the same here!
Co-authored-by: George Gritsouk <[email protected]>
Co-authored-by: George Gritsouk <[email protected]>
Co-authored-by: George Gritsouk <[email protected]>
Co-authored-by: George Gritsouk <[email protected]>
…/develop into DominikB2014/asset-module-docs
Co-authored-by: Ash <[email protected]>
…/develop into DominikB2014/asset-module-docs
Initial asset module docs