1762483 - Spelling mistake: "DOM notes" -> "DOM nodes"

Status: RESOLVED FIXED

(DevTools :: Documentation, task, P3)

Description

[akaabdullahmateen]

User Agent: Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:98.0) Gecko/20100101 Firefox/98.0

Steps to reproduce:

Just open the page: https://firefox-source-docs.mozilla.org/devtools-user/debugger/how_to/highlight_and_inspect_dom_nodes/index.html

Actual results:

In the second paragraph which reads: "When you are working with DOM notes in the debugger, ...", the word "notes" is incorrect.

Expected results:

In the second paragraph which reads: "When you are working with DOM notes in the debugger, ...", the word "notes" should be replaced with "nodes".

Comment 1

[Julian Descottes [:jdescottes]]

Thanks for filing!

Are you interested in taking this bug? Happy to mentor.

Comment 2

[av]

Hi.

I would be happy to work on this bug if it is open.

Comment 3

[Jan Honza Odvarko [:Honza] (always need-info? me)]

Assigned to you, thank you for helping.

Comment 4

[av]

I can't seem to locate the index.html file. I am looking at the directory "\mozilla-unified\devtools\docs\user\debugger\how_to\highlight_and_inspect_dom_nodes"

Is that the right place?

Comment 5

[Julian Descottes [:jdescottes]]

(In reply to av from comment #4)

I can't seem to locate the index.html file. I am looking at the directory "\mozilla-unified\devtools\docs\user\debugger\how_to\highlight_and_inspect_dom_nodes"

Is that the right place?

You can use searchfox to find code. If you look for "When you are working with DOM notes in the debugger" you will find https://searchfox.org/mozilla-central/source/devtools/docs/user/debugger/how_to/highlight_and_inspect_dom_nodes/index.rst#7

Meaning the file is at devtools/docs/user/debugger/how_to/highlight_and_inspect_dom_nodes/index.rst

index.html is a generated file, created from index.rst

Comment 6

[av]

From my understanding, are we required to use python to generate the html file? Is there a tool in Visual Studio that would be able to accomplish this?

I'm assuming that after converting the .rst to .html, I can then edit the html file. After this, I would need to convert the html back to .rst before pushing changes.

Comment 7

[Julian Descottes [:jdescottes]]

(In reply to av from comment #6)

From my understanding, are we required to use python to generate the html file? Is there a tool in Visual Studio that would be able to accomplish this?

I'm assuming that after converting the .rst to .html, I can then edit the html file. After this, I would need to convert the html back to .rst before pushing changes.

No, you don't need to edit the .html file, this file is not under our source control.

The .html file is generated dynamically from the .rst file when we publish our docs. You have to replace "notes" with "nodes" at line 7 in devtools/docs/user/debugger/how_to/highlight_and_inspect_dom_nodes/index.rst, commit your changes and push the patch to phabricator.

If you want to generate the documentation locally, you can use ./mach docs, and yes it will use python behind the scenes (but again don't edit the html files it will generate, those are ignored by the source control).

See https://firefox-source-docs.mozilla.org/setup/index.html if you need help to setup your environment.

Comment 8

[av]

Makes sense. Thank you. Patch will be up soon.

Comment 9

[av]

Attachment: Bug 1762483 - Spelling mistake: 'DOM notes' -> 'DOM nodes' r=kpatenio,niklas

Depends on D143549

Comment 10

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/ba7c9f270e19
Spelling mistake: 'DOM notes' -> 'DOM nodes' r=jdescottes

Comment 11

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/ba7c9f270e19