1365216 - Devtools: bring over documentation for how to find documentation into the tree

Status: RESOLVED FIXED

(DevTools :: General, enhancement)

Description

[Soledad Penades [:sole] [:spenades]]

Move contents of https://wiki.mozilla.org/DevTools/Hacking#Finding_documentation to https://dxr.mozilla.org/mozilla-central/source/devtools/docs/README.md mostly

Comment 1

[Soledad Penades [:sole] [:spenades]]

Attachment: Bug 1365216 - DevTools: bring over documentation for how to find documentation into the tree.

Review commit: https://reviewboard.mozilla.org/r/139718/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/139718/

Comment 2

[Patrick Brosset <:pbro>]

Comment on attachment 8868109 [details]
Bug 1365216 - DevTools: bring over documentation for how to find documentation into the tree.

https://reviewboard.mozilla.org/r/139718/#review143354

Nice work! I just a few minor comments. See below.
Thanks Sole.

::: devtools/docs/getting-started/build.md:3
(Diff revision 1)
> +# Set up to build Firefox Developer Tools
> +
> +These are the steps we're going to look at:

Do we need an intro that explains again the difference between code on m-c and code on github, and that if people are looking at how to build the debugger.html, then they should look at this other page ...

::: devtools/docs/getting-started/build.md:41
(Diff revision 1)
> +./mach build
> +```
> +
> +If your system needs additional dependencies installed (for example, Python, or a compiler, etc), various diagnostic messages will be printed to your screen. Follow their advice and try building again.
> +
> +Building also takes a long time (specially on slow computers).

I would also add that building takes only a long time the first time. Then incremental builds are faster.

::: devtools/docs/getting-started/build.md:53
(Diff revision 1)
> +
> +```bash
> +./mach run
> +```
> +
> +This will run using an empty temporary profile which is discarded when you close the browser. We will look more into persistent development profiles later.<!--TODO: add link to that section when it's written-->

We do have a page about creating a dev profile, right? Maybe we can already add the link and remove this comment.

::: devtools/docs/getting-started/development-profiles.md:7
(Diff revision 1)
> +
> +You can have various [Firefox profiles](https://developer.mozilla.org/en-US/Firefox/Multiple_profiles) (think of something like "user accounts"), each one with different settings, addons, appearance, etc.
> +
> +This page will guide you through configuring a new profile to enable development features such as additional logging, dumping of network packets, remote debugging, etc. which will help when working in DevTools.
> +
> +Many of these changes are achieved by modifying preferences in `about:config`, an special page you can access by entering that in Firefox's URL bar. The first time, it will show you a warning page. Click through and then you can start searching for preferences to modify.

nit: "an special page" -> "a special page"

::: devtools/docs/getting-started/development-profiles.md:43
(Diff revision 1)
> +
> +## Enable remote debugging and the Browser Toolbox
> +
> +These settings allow you to use the [browser toolbox](https://developer.mozilla.org/docs/Tools/Browser_Toolbox) to inspect the DevTools themselves, set breakpoints inside of DevTools code, and run the [Scratchpad](https://developer.mozilla.org/en-US/docs/Tools/Scratchpad) in the *Browser* environment.
> +
> +Open DevTools, and click the "Toolbox Options" gear icon in the top right (the image underneath is outdated). <!--TODO update image--> 

I see this commit does update the image. Is the comment still required now?

::: devtools/docs/getting-started/servers-and-actors.md:1
(Diff revision 1)
> +# Servers and actors

I'm a bit confused by the title of this page. This is a very high level architecture overview of the tools, but the title suggests that the page is only about the server and about what actors are.
`Architecture overview` would convey the usefulness of this page better for me.

Comment 3

[Carsten Book [:Tomcat]]

5 open issues that need to be fixed first before we can autoland this

Comment 4

[Soledad Penades [:sole] [:spenades]]

Attachment: Bug 1365216 - Follow up.

Review commit: https://reviewboard.mozilla.org/r/140192/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/140192/

Comment 5

[Soledad Penades [:sole] [:spenades]]

Comment on attachment 8868109 [details]
Bug 1365216 - DevTools: bring over documentation for how to find documentation into the tree.

https://reviewboard.mozilla.org/r/139718/#review143354

I addressed the concerns in a follow up commit, hopefully they'll show up here and this can land!

> Do we need an intro that explains again the difference between code on m-c and code on github, and that if people are looking at how to build the debugger.html, then they should look at this other page ...

That is mentioned in getting-started/where-is-the-code which is "two pages" before this one, and also the first item in the list of 'getting started'. We can link to it from github (I took the content from there, from where I will remove it once this is landed)

> I would also add that building takes only a long time the first time. Then incremental builds are faster.

Not sure that adds value to the intro. We address that later...

> We do have a page about creating a dev profile, right? Maybe we can already add the link and remove this comment.

Yes! I will follow up.

> I see this commit does update the image. Is the comment still required now?

Yes, I just took the image from MDN and it is still outdated.

> I'm a bit confused by the title of this page. This is a very high level architecture overview of the tools, but the title suggests that the page is only about the server and about what actors are.
> `Architecture overview` would convey the usefulness of this page better for me.

Sounds good, I'll follow up. Thanks!

Comment 6

[Ryan VanderMeulen [:RyanVM]]

Part 2 needs r+ in MozReview before Autoland can push it.

Comment 7

[Patrick Brosset <:pbro>]

Comment on attachment 8868602 [details]
Bug 1365216 - Follow up.

https://reviewboard.mozilla.org/r/140192/#review143910

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/73352636650f
DevTools: bring over documentation for how to find documentation into the tree. r=pbro
https://hg.mozilla.org/integration/autoland/rev/b64068d6364a
Follow up. r=pbro

Comment 9

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/73352636650f
https://hg.mozilla.org/mozilla-central/rev/b64068d6364a