Added doc for local profiling on android with screenshots#4145
Conversation
There was a problem hiding this comment.
Thanks, this looks good to me!
Some comments:
- Can you make sure to run the png files through optipng or a similar tool to reduce the size of the png? On my computer I can reduce each file size by more than 30% using optipng.
- About where to put it, I feel like it's good in its own file, however we could have cross links (in both directions) between this file and the remote profiling page.
Maybe you could add anFirefox for Androidsection in the sidebar with both pagesLocal ProfilingandRemote Profiling.
I'll be waiting for these changes before approving :)
| - Choose one of the four options that matches the closest to what you're trying to profile. | ||
| - Click "Start Profiler" and a toast should appear with the "Profiler started" message. | ||
|
|
||
| ### To stop the prfoiler |
There was a problem hiding this comment.
not:
| ### To stop the prfoiler | |
| ### To stop the profiler |
| @@ -0,0 +1,34 @@ | |||
| # Local Profiling Firefox for Android | |||
There was a problem hiding this comment.
When reading Local Profiling I initially thought about profiling with an emulator on a desktop machine.
I wonder if we can find a a better title... What about Profiling Firefox for Android directly on the device? Is it too long?
| - Go back to the Settings screen | ||
| - Scroll to the bottom and you should see a "Stop profiler" option has replaced the "Start Profiler" one. | ||
| - After you click it, you should see a dialogue with a warning regarding the information contained in the profile. | ||
| - Once stopped, the URL for the profile that has just been taken will be copied to your clipboard which you can then use to share. |
There was a problem hiding this comment.
Our test checker alex errors on the word just here, even though that's an appropriate use here. I believe that you can add <!--alex ignore just--> before the list to ignore it.
You can run yarn test-alex to run the tool locally.
Malclir
force-pushed
the
doc_local_profiling_android
branch
from
a92b265 to
eea6395
Compare
|
@julienw I ran it through As for the side bar with two sub sections, I like that idea. Again, not sure how the markdown functions for that one so I based myself on what was there. |
Codecov Report
@@ Coverage Diff @@
## main #4145 +/- ##
==========================================
- Coverage 88.28% 88.27% -0.01%
==========================================
Files 280 280
Lines 24414 24388 -26
Branches 6490 6477 -13
==========================================
- Hits 21554 21529 -25
+ Misses 2656 2655 -1
Partials 204 204
Continue to review full report at Codecov.
|
|
Hey @MarcLeclair, thanks for latest changes, this looks good to me! |
|
That looks good to me @julienw thanks for the edit! I wasn't too sure how to make a sub header. |
TBH I was thinking about a top level header, but what you did looks good to me too, so I kept it :-) |
2 participants
With the addition of the Firefox profiler on android, we wanted to add some doc to help users navigate it. I was going to add it to the performance wiki but this felt more centralized.
I wasn't sure where to add the doc so I created a new file, but I was also thinking it could live within the remote profiling doc and just rename it. I didn't want to make any decision regarding that so I decided to open a new PR and see what others have to say!