[remote-dbg-next] Review documentation links in new about:debugging
Categories
(DevTools :: about:debugging, enhancement, P3)
Tracking
(firefox68 fixed)
| Tracking | Status | |
|---|---|---|
| firefox68 | --- | fixed |
People
(Reporter: jdescottes, Assigned: ladybenko)
References
(Blocks 1 open bug)
Details
(Whiteboard: high-priority-reserve)
Attachments
(1 file)
Might become a meta bug. We should review all the links we have in the about:debugging UI and make sure they point to up to date MDN links.
We should first collect all the existing links to help Irene prioritize the documentation work for Remote Debugging, that could start on Apr 15.
|
Reporter | |
Comment 1•5 years ago
|
||
We currently have the following links in the UI:
- https://developer.mozilla.org/docs/Tools/WebIDE/Troubleshooting
- where: in the Runtime pages, in the backward compatibility warnings displayed when connecting to a too old or too recent browser as "Troubleshooting"
- comments:
We don't currently have such links in WebIDE, so the current page is really irrelevant.
We should have a section in our documentation that talks about the backward compatibility policy (and exceptions) in DevTools.
- https://developer.mozilla.org/en-US/docs/Tools/about:debugging#Enabling_add-on_debugging
- where: in This Nightly / This Firefox, next to the "Enable extension debugging" as "Learn more"
- comments:
The url is still relevant, as it explains the technical details about what the checkbox does, even though it is lost in a huge page that documents the old about:debugging UI.
- https://developer.mozilla.org/en-US/docs/Tools/about%3Adebugging#Service_workers_not_compatible
- where: in the Runtime pages, if the configuration of the browser is not compatible with Service Workers
- comments:
Same as for addon debugging, the explanations found at the URL are still relevant, but the screenshot is outdated.
- https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/Debugging_Firefox_for_Android_with_WebIDE#Setting_up_the_Android_device
- where: in the Setup page, when "USB Debugging" is enabled, in the USB section as "Learn how" links next to each step.
- comments:
This section of the content is relevant for Firefox for Android, but all the rest of the page is only about WebIDE. This is probably the most important resource to create: a new landing page that explains how to handle USB connection with a device running Firefox for Android.
- https://developer.mozilla.org/Add-ons/WebExtensions/WebExtensions_and_the_Add-on_ID
- where: in This Nightly / This Firefox, in the "Temporary Extension" category when a Temporary Extension is loaded
- comments: this page barely mentions about:debugging, and can mostly be reused as is
- https://developer.mozilla.org/en-US/docs/Tools/about:debugging
- where: "Debugging Support" in the bottom left of the application, always displayed
- comments: The whole page talks about the old about:debugging UI and is mostly outdated.
From the quick review above, it seems like we need two new resources:
- one documentation page to document USB debugging
- one documentation page for the updated about:debugging UI
with the necessary anchors to get the detailed info about serviceworkers, addondebugging, backward compatibility policy etc...
The main priority between the two is the updated page for USB debugging. The current page is called "https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/Debugging_Firefox_for_Android_with_WebIDE" and since we will both have WebIDE and the new remote debugging side by side in Fx68, we will probably need to keep the two pages around for some time.
|
Assignee | |
Updated•5 years ago
|
How do we want to proceed with https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/Debugging_Firefox_Desktop ?
|
|
Reporter | |
Comment 3•5 years ago
•
|
||
(In reply to Ola Gasidlo [:ogasidlo] [:ola] from comment #2)
How do we want to proceed with https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/Debugging_Firefox_Desktop ?
We are not linking to this page currently.
Discussion about the documentation on MDN itself should happen on the MDN github issues dedicated for that. Irene, I don't think the GitHub issues for remote debugging documentation have been created yet. Could you share the link here?
That being said we could add a new link in the network location section that points to the new documentation, once it's ready. I think it would be better to have a follow up for this.
|
||
Comment 4•5 years ago
|
||
I have created an issue for this MDN/Sprints #1346 and added it to the Remote Debugging Epic which I'm using to track the documentation effort.
|
|
Reporter | |
Updated•5 years ago
|
|
|
Assignee | |
Updated•5 years ago
|
|
|
||
Comment 5•5 years ago
•
|
||
Created the following placeholder:
Debugging over a network
Debugging over USB
Please let me know if you need any other new pages.
|
|
Assignee | |
Comment 6•5 years ago
|
||
Pushed by balbeza@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/230016dbba05 Update documentation links in the new about:debugging. r=jdescottes,daisuke,Ola
|
||
Comment 9•5 years ago
|
||
| bugherder | ||
Description
•