Closed Bug 1752374 Opened 3 years ago Closed 2 years ago

Update performance panel documentation

Categories

(DevTools :: Documentation, task)

task

Tracking

(firefox103 fixed)

RESOLVED FIXED
103 Branch
Tracking Status
firefox103 --- fixed

People

(Reporter: nchevobbe, Assigned: julienw)

References

Details

Attachments

(1 file)

https://firefox-source-docs.mozilla.org/devtools-user/performance/ refers to the old panel. Since we plan to enable the new panel soon, we should update this page.

Should we redirect to the documentation in https://profiler.firefox.com/docs/ ? We may need to update that one too, but it may be easier to have it in one place only.

For example the UI tour is here: https://profiler.firefox.com/docs/#/./guide-ui-tour

Agree, having the doc in one place sounds good to me. The existing page [1] can contain just simple sentence pointing to [2].

[1] https://firefox-source-docs.mozilla.org/devtools-user/performance/
[2] https://profiler.firefox.com/docs/#/./guide-ui-tour

I added some more content to the profiler doc (latest is https://github.com/firefox-devtools/profiler/pull/4096). I'd like to look again at the existing old performance panel documentation and see what we might miss still, but I believe we could move it soon.

BTW as far as I could find there's no direct link to https://firefox-source-docs.mozilla.org/devtools-user/performance/, however we can find it when using the search box.

I noticed some existing documentation is pointing to scenarios that disappeared from github but are still in the Web Archive in https://web.archive.org/web/20201110154344/https://mdn.github.io/performance-scenarios/. (I'm putting the link here just so that I don't have to look for it again)

Thank you for working on the docs, Julien!

(In reply to Julien Wajsberg [:julienw] from comment #3)

BTW as far as I could find there's no direct link to https://firefox-source-docs.mozilla.org/devtools-user/performance/, however we can find it when using the search box.

There is a link on this page. See "Performance Tools" section:
https://firefox-source-docs.mozilla.org/devtools-user/index.html

Looks like the screenshot there could be updated. It's this file:
https://searchfox.org/mozilla-central/source/devtools/docs/user/landingpage_performance.png

Honza

Ah I see, the screenshot itself is the link, I missed that!
Thanks

This replaces the documentation by a link to the online documentation to
the Firefox Profiler.

Assignee: nobody → felash
Status: NEW → ASSIGNED
Pushed by jwajsberg@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/563344a5a354 [devtools documentation] Remove the documentation about the old performance panel r=jdescottes DONTBUILD
Pushed by bszekely@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/43af4e504df7 fixed lint failures r=lint-fix CLOSED TREE
Status: ASSIGNED → RESOLVED
Closed: 2 years ago
Resolution: --- → FIXED
Target Milestone: --- → 103 Branch
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: