doc: use 'Node.js' instead of 'Node' per Foundation branding guidelines #23967

Trott · 2018-10-30T05:40:04Z

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
documentation is changed or added
commit message follows commit guidelines

nodejs-github-bot · 2018-10-30T05:40:05Z

@Trott build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/1415/pipeline

richardlau

Can we lint for this? (I thought we already did like we do for "V8" but clearly we don't otherwise the linter would be failing.)

richardlau · 2018-10-30T06:14:56Z

Can we lint for this? (I thought we already did like we do for "V8" but clearly we don't otherwise the linter would be failing.)

Ah we only lint for "Node.JS":

node/tools/lint-md.js

Line 33286 in b255cd4

{ no: 'Node.JS', yes: 'Node.js' },

(from https://github.com/watilde/remark-preset-lint-node/blob/f9ad8005a90e5056028df96d2cb24de8bdf1c649/index.js#L47)

Trott · 2018-10-30T06:16:29Z

Can we lint for this? (I thought we already did like we do for "V8" but clearly we don't otherwise the linter would be failing.)

@richardlau Yes, but there are problems, such as an unclear error message because of the way the lint plugin handles regexp-y things. Fortunately, I'm the maintainer of the lint plugin, and I have it on my to-do list to fix this so that we can enable it eventually. (Or if some eager contributor wants to beat me to it, go for it. It's Trott/remark-lint-prohibited-strings#2.)

We do currently lint for NodeJS and recommend Node.js instead, but that's it. We don't lint for other variants like Node.

fhinkel · 2018-10-30T09:24:15Z

When did the guidelines change? Last time I looked them up it said Node.js for headlines, and Node in text. Could you link to the guidelines please?

Trott · 2018-10-30T14:24:07Z

When did the guidelines change? Last time I looked them up it said Node.js for headlines, and Node in text. Could you link to the guidelines please?

@fhinkel AFAIK, it didn't change. I've always understood it to be "Node.js, never Node, but node is OK if referring to the executable".

It's possible I've misunderstood but it does appear that the Foundation website homepage uses Node.js everywhere--headlines, text, etc.--with the sole exception of Node+JS Interactive.

Maybe someone (Zibby?) from Foundation marketing can chime in. /ping @nodejs/foundation

ZibbyKeaton · 2018-10-30T14:34:10Z

Happy to chime in. The guidelines that we started at least when the Foundation was formed was to use Node.js consistently and everywhere (headlines, text, etc.).

fhinkel · 2018-10-30T16:53:44Z

@Trott and @ZibbyKeaton thanks for following up. LGTM

doc/node.1

doc/guides/node-postmortem-support.md

richardlau · 2018-10-30T18:22:54Z

When did the guidelines change? Last time I looked them up it said Node.js for headlines, and Node in text. Could you link to the guidelines please?

@fhinkel AFAIK, it didn't change. I've always understood it to be "Node.js, never Node, but node is OK if referring to the executable".

It's possible I've misunderstood but it does appear that the Foundation website homepage uses Node.js everywhere--headlines, text, etc.--with the sole exception of Node+JS Interactive.

Maybe someone (Zibby?) from Foundation marketing can chime in. /ping @nodejs/foundation

I think what @fhinkel might be remembering is the old (pre-Foundation) wiki FAQ: https://github.com/nodejs/wiki-archive/blob/master/node-v0.x-archive/FAQ.md#what-is-the-official-spellingcapitalizationpronunciation:

What is the "official" spelling/capitalization/pronunciation?

When referring to the software or the project in general, it's Node.js or simply Node. It is a proper noun, so capitalize it. The .js appears with the first use, to disambiguate from other things called "Node", and Node (without the .js) afterwards. One way to think of this is that Node.js is the full name, and Node is the more familiar first name.

When referring specifically to the binary executable, it's always node, lower-case to match the binary's name itself.

When referring to the libs that are included with the binary, as opposed to the libs published by Node users in The npm Registry, it's node-core or node core. (See [[node core vs userland]].)

"npm" is always lowercase, even when it appears at the start of a sentence, unless used in a context where all-caps are used (such as the title of a man page.)

"Node.js" is pronounced either "node dot jay ess", or "node jay ess", or "node point javascript".

"npm" is pronounced "en pee em", spelled out.

Per branding guidelines from the Foundation, use Node.js and not Node.

Use Node.js instead of Node per branding guidelines.

Trott · 2018-10-31T02:26:14Z

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/1432/

Trott · 2018-11-01T06:27:16Z

Landed in 51294c8...7b09f5b

Per branding guidelines from the Foundation, use Node.js and not Node. PR-URL: nodejs#23967 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Matheus Marchini <mat@mmarchini.me> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

PR-URL: nodejs#23967 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Matheus Marchini <mat@mmarchini.me> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

Per branding guidelines from the Foundation, use Node.js and not Node. PR-URL: #23967 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Matheus Marchini <mat@mmarchini.me> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

PR-URL: #23967 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Matheus Marchini <mat@mmarchini.me> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>