Create unified nav elements for Perf APIs. #229

jpmedley · 2017-06-26T22:15:26Z

No description provided.

jpmedley · 2017-07-10T08:32:57Z

chrisdavidmills · 2017-07-10T09:00:10Z

Hi Joe,

I'm a bit confused here. Why have you added an entry to GroupData for this API, but also made a separate PerformanceSidebar Macro? The added GroupData is read and turned into a sidebar by the APIRef macro:

https://github.com/mozilla/kumascript/blob/master/macros/APIRef.ejs

See https://developer.mozilla.org/en-US/docs/Web/API/WebVR_API for an example of how this is used.

I'll review your GroupData entry too.

chrisdavidmills · 2017-07-10T09:01:09Z

macros/GroupData.json

+                            "PerformanceNavigationTiming",
+                            "PerformanceObserver",
+                            "PerformanceResourceTiming",
+                            "window.performance" ],


Window.performance

chrisdavidmills · 2017-07-10T09:03:32Z

macros/GroupData.json

+                            "PerformanceNavigationTiming.redirectCount",
+                            "PerformanceNavigationTiming.type",
+                            "PerformanceNavigationTiming.unloadEventEnd",
+                            "PerformanceNavigationTiming.unloadEVentStart",


unloadEventStart

jpmedley · 2017-07-12T08:15:31Z

@chrisdavidmills PTAL

jpmedley · 2017-07-17T18:47:38Z

@chrisdavidmills Is there anything else I need to do to this?

chrisdavidmills · 2017-07-18T13:33:37Z

Sorry Joe; I've still not had a chance to go through this. I'll get to it soon, promise.

jpmedley · 2017-07-25T14:24:47Z

@chrisdavidmills

chrisdavidmills · 2017-07-25T14:26:33Z

Do you know what? I'm drowning in work, and having a terrible time finding the time to look at this. Sorry Joe.

@Elchi3 , this looks OK to me from a cursory glance. Can you give it a second look if you get the chance?

jpmedley · 2017-07-25T14:31:37Z

Thanks, guys! Joe Medley | Technical Writer, Chrome DevRel | jmedley@google.com | 816-678-7195 *If an API's not documented it doesn't exist.*

…

On Tue, Jul 25, 2017 at 7:26 AM, Chris Mills ***@***.***> wrote: Do you know what? I'm drowning in work, and having a terrible time finding the time to look at this. Sorry Joe. @Elchi3 <https://github.com/elchi3> , this looks OK to me from a cursory glance. Can you give it a second look if you get the chance? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#229 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AH0vi3YQkJF81s09SQtS3V_iUMJP55W7ks5sRfsZgaJpZM4OF6_q> .

Elchi3 · 2017-07-25T14:43:50Z

This question still stands. What's the motivation for {{PerformanceSidebar}} ?

Why have you added an entry to GroupData for this API, but also made a separate PerformanceSidebar Macro?

jpmedley · 2017-07-25T15:05:20Z

Sorry for the turmoil. What I had in mind is slowly coming back to me. I had intended to add more to what the macro showed after getting it sanity checked.To be honest, I'm now thinking my reasoning was a bit shaky. Here's the problem I thought I was solving. The APIs listed in group data are all related yet many of them have separate entries in groupdata, and separate overview pages. At the time I opened this PR, I believed I was saving us the trouble of editing a few hundred APIRef() macro calls (shaky reasoning). Unless someone has another idea, let me take another shot at this using just groupdata. Again, sorry for the turmoil. Joe Joe Medley | Technical Writer, Chrome DevRel | jmedley@google.com | 816-678-7195 *If an API's not documented it doesn't exist.*

…

On Tue, Jul 25, 2017 at 7:43 AM, Florian Scholz ***@***.***> wrote: This question still stands. What's the motivation for {{PerformanceSidebar}} ? Why have you added an entry to GroupData for this API, but also made a separate PerformanceSidebar Macro? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#229 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AH0vi2M3UnI6rrwHGFagjXGccB7--Vutks5sRf8ngaJpZM4OF6_q> .

Elchi3 · 2017-07-25T18:51:42Z

No worries, Joe. I think this should be good with just the GroupData entries.

(Refactoring the sidebars to be somewhat more coherent and solid is on my radar, but won't happen anytime soon. Also, we need to first find out how much they are used to judge if it is worth our time to improve this code).

jpmedley · 2017-07-25T20:07:14Z

I actually thought unifying the sidebar and creating a master overview page would be a lot of bang for very few bucks. I personally think the ability to test performance in the wild has enormous value. Joe Medley | Technical Writer, Chrome DevRel | jmedley@google.com | 816-678-7195 *If an API's not documented it doesn't exist.*

…

On Tue, Jul 25, 2017 at 11:51 AM, Florian Scholz ***@***.***> wrote: No worries, Joe. I think this should be good with just the GroupData entries. (Refactoring the sidebars to be somewhat more coherent and solid is on my radar, but won't happen anytime soon. Also, we need to first find out how much they are used to judge if it is worth our time to improve this code). — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#229 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AH0vi9vbo3U84BhDtvcWl_4eVZJknGUvks5sRjlLgaJpZM4OF6_q> .

jpmedley · 2017-07-25T21:12:34Z

Performance navigation, take II. This is part 1 of 3.

1. Create "Performance API" in GroupData.json.
2. Add {{APIRef("Performance API")}} to relevant pages.
3. Remove other API groups from GroupData.json ("Performance Timeline API" for example.)

Elchi3 · 2017-07-26T12:04:14Z

macros/GroupData.json

+                              "title": "Long Tasks API" },
+                            { "url": "/en-US/docs/Web/API/Navigation_timing_API",
+                              "title": "Navigation Timing API" },
+                            { "url": "/en-US/docs/Web/API/Navigation_timing_API/Using_Navigation_Timing",


https://developer.mozilla.org//en-US/docs/Web/API/Navigation_timing_API/Using_Navigation_Timing
This page page looks useless. Are you planning to write something here? If not, I think it shouldn't be here for now.

Elchi3 · 2017-07-26T12:06:05Z

macros/GroupData.json

+                            "TaskAttributionTiming.containerName",
+                            "TaskAttributionTiming.containerSrc",
+                            "TaskAttributionTiming.containerType" ],
+            "events":     [ "Performance.onresourcetimingbufferfull" ]


This needs to be the name of the event "resourcetimingbufferfull" to create a link to the event page:
https://developer.mozilla.org/en-US/docs/Web/Events/resourcetimingbufferfull

Elchi3

See the two comments, but we are really close!

Also, note that guides are only used by {{DefaultAPISidebar("Performance API")}}, so we've been using that on overview pages (c.f. https://developer.mozilla.org/en-US/docs/Web/API/Gamepad_API) and {{APIRef("Performance API")}} on reference pages (c.f. https://developer.mozilla.org/en-US/docs/Web/API/Gamepad). (Probably not ideal, but this is how this stuff currently works, ICYDK.)

jpmedley · 2017-07-26T14:44:42Z

PTAL

Elchi3 · 2017-07-26T14:53:57Z

Almost! I meant "events": [ "resourcetimingbufferfull" ]

This is used to build https://developer.mozilla.org/en-US/docs/Web/Events/ + eventName and the URL here is https://developer.mozilla.org/en-US/docs/Web/Events/resourcetimingbufferfull.

jpmedley · 2017-07-26T15:13:48Z

PTAL

Elchi3

great!

- mdn/kumascript#229 - GroupData: Performance API - mdn/kumascript#241 - DekiScript-Page, DekiScript-Wiki: API calls - mdn/kumascript#246 - AddonSidebar: Fixes, Working with files - mdn/kumascript#247 - AddonSidebar: Publist and Distribution - mdn/kumascript#252 - GroupData: Media Streams API - mdn/kumascript#254 - GameTechBox: Add pt-BR - mdn/kumascript#258 - L10nStatusOverview: Add pr-BR - mdn/kumascript#259 - AddonSidebar: Themes - mdn/kumascript#260 - AddonSidebar: Contact method - mdn/kumascript#261 - many macros: Use mdn.localStringMap - mdn/kumascript#262 - GroupData: Stream API methods -> properties

Create unified nav elements for Perf APIs.

5b36538

chrisdavidmills reviewed Jul 10, 2017

View reviewed changes

Fix typos.

7d518ec

jpmedley added 2 commits July 25, 2017 14:08

Add guides to perf API navigation.

4bdc6b0

Merge branch 'perf' of https://github.com/jpmedley/kumascript into perf

eb9328b

Add Long Tasks API.

452be5a

Elchi3 reviewed Jul 26, 2017

View reviewed changes

Elchi3 suggested changes Jul 26, 2017

View reviewed changes

Fixes from Elchi3.

8ae256e

Second try on events.

b4ea6db

Elchi3 approved these changes Jul 26, 2017

View reviewed changes

Elchi3 merged commit d78bbe2 into mdn:master Jul 26, 2017

jpmedley deleted the perf branch July 26, 2017 22:06

jwhitlock mentioned this pull request Aug 1, 2017

Update KS, PRs 229,241,246,247,252,254,258-262 mdn/kuma#4343

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create unified nav elements for Perf APIs. #229

Create unified nav elements for Perf APIs. #229

jpmedley commented Jun 26, 2017

jpmedley commented Jul 10, 2017

chrisdavidmills commented Jul 10, 2017

chrisdavidmills Jul 10, 2017

chrisdavidmills Jul 10, 2017

jpmedley commented Jul 12, 2017 •

edited

Loading

jpmedley commented Jul 17, 2017

chrisdavidmills commented Jul 18, 2017 •

edited

Loading

jpmedley commented Jul 25, 2017

chrisdavidmills commented Jul 25, 2017

jpmedley commented Jul 25, 2017 via email

Elchi3 commented Jul 25, 2017

jpmedley commented Jul 25, 2017 via email

Elchi3 commented Jul 25, 2017

jpmedley commented Jul 25, 2017 via email

jpmedley commented Jul 25, 2017

Elchi3 Jul 26, 2017

Elchi3 Jul 26, 2017

Elchi3 left a comment

jpmedley commented Jul 26, 2017

Elchi3 commented Jul 26, 2017

jpmedley commented Jul 26, 2017

Elchi3 left a comment

Create unified nav elements for Perf APIs. #229

Create unified nav elements for Perf APIs. #229

Conversation

jpmedley commented Jun 26, 2017

jpmedley commented Jul 10, 2017

chrisdavidmills commented Jul 10, 2017

chrisdavidmills Jul 10, 2017

Choose a reason for hiding this comment

chrisdavidmills Jul 10, 2017

Choose a reason for hiding this comment

jpmedley commented Jul 12, 2017 • edited Loading

jpmedley commented Jul 17, 2017

chrisdavidmills commented Jul 18, 2017 • edited Loading

jpmedley commented Jul 25, 2017

chrisdavidmills commented Jul 25, 2017

jpmedley commented Jul 25, 2017 via email

Elchi3 commented Jul 25, 2017

jpmedley commented Jul 25, 2017 via email

Elchi3 commented Jul 25, 2017

jpmedley commented Jul 25, 2017 via email

jpmedley commented Jul 25, 2017

Elchi3 Jul 26, 2017

Choose a reason for hiding this comment

Elchi3 Jul 26, 2017

Choose a reason for hiding this comment

Elchi3 left a comment

Choose a reason for hiding this comment

jpmedley commented Jul 26, 2017

Elchi3 commented Jul 26, 2017

jpmedley commented Jul 26, 2017

Elchi3 left a comment

Choose a reason for hiding this comment

jpmedley commented Jul 12, 2017 •

edited

Loading

chrisdavidmills commented Jul 18, 2017 •

edited

Loading