tools,doc: avoid generating duplicate id attributes

[Trott]

In all.html, we currently generate hundreds of duplicate id attributes
because of conflicts between the way allhtml.mjs prefixes in-page links
with the module name on the one hand, and the existence of legacy id
attributes hardcoded into the page on the other hand.

This prefaces the module name with all_ to avoid the conflicts.

[nodejs-github-bot]

CI: https://ci.nodejs.org/job/node-test-pull-request/41625/

[aduh95]

This prefaces the module name with all_ to avoid the conflicts.

Wouldn't that break existing links? (like a link from a StackOverflow post that lead to Node.js docs)

[Trott]

This prefaces the module name with all_ to avoid the conflicts.

Wouldn't that break existing links? (like a link from a StackOverflow post that lead to Node.js docs)

Two responses:

1. Yes, sometimes, but often not. There are lots of duplicate IDs being generated so the duplicates are still there and working.
2. And for the ones that do break: I'm not concerned, honestly. This is in all.html, a 6.6 Mb file that is mostly there for people that need to do "command F" searching the docs and for people who like to easily print their documentation on 100s of pages of paper. Most links from StackOverflow and elsewhere go do the individual module pages instead. Those links are unaffected.

[Trott]

• Yes, sometimes, but often not. There are lots of duplicate IDs being generated so the duplicates are still there and working.
• And for the ones that do break: I'm not concerned, honestly. This is in all.html, a 6.6 Mb file that is mostly there for people that need to do "command F" searching the docs and for people who like to easily print their documentation on 100s of pages of paper. Most links from StackOverflow and elsewhere go do the individual module pages instead. Those links are unaffected.

Oh, and 3.: This won't affect links in previous versions. So only relatively recent links to https://nodejs.org/dist/latest-v17.x/docs/api/all.html. If we want, we can decide not to land this on LTS to preserve the links in https://nodejs.org/dist/latest-v16.x/docs/api/all.html and earlier. And for v18.x and later, the non-all-prefixed links will never have existed in the first place.

So on balance, I consider the breaking possibilities fairly minimal. (Plus the link still "works", it just won't scroll you to the right place in the doc. So you'll have to command-f search or whatever.)

[aduh95]

we can decide not to land this on LTS to preserve the links in https://nodejs.org/dist/latest-v16.x/docs/api/all.html and earlier

#39304 only landed on v16.12.0 which is two months old, and wasn't backported to earlier release lines. Yeah you're right, it's probably fine to land this and even have it landed on v16.x sooner rather than later.

[nodejs-github-bot]

Landed in 5cc4b69...83f442a