Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
wants to merge 3 commits into from

Conversation

Trott
Copy link
Member

@Trott Trott commented Oct 30, 2018

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

@nodejs-github-bot nodejs-github-bot added build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. labels Oct 30, 2018
Copy link
Member

@richardlau richardlau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

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":

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

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

@Trott
Copy link
Member Author

Trott commented Oct 30, 2018

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
Copy link
Member

fhinkel commented Oct 30, 2018

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
Copy link
Member Author

Trott commented Oct 30, 2018

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
Copy link

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
Copy link
Member

fhinkel commented Oct 30, 2018

@Trott and @ZibbyKeaton thanks for following up. LGTM

doc/node.1 Outdated Show resolved Hide resolved
@richardlau
Copy link
Member

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
Copy link
Member Author

Trott commented Oct 31, 2018

@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 31, 2018
@Trott
Copy link
Member Author

Trott commented Nov 1, 2018

Landed in 51294c8...7b09f5b

@Trott Trott closed this Nov 1, 2018
Trott added a commit to Trott/io.js that referenced this pull request Nov 1, 2018
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>
Trott added a commit to Trott/io.js that referenced this pull request Nov 1, 2018
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>
targos pushed a commit that referenced this pull request Nov 1, 2018
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>
targos pushed a commit that referenced this pull request Nov 1, 2018
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>
MylesBorins pushed a commit that referenced this pull request Nov 27, 2018
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>
MylesBorins pushed a commit that referenced this pull request Nov 27, 2018
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>
MylesBorins pushed a commit that referenced this pull request Nov 27, 2018
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>
MylesBorins pushed a commit that referenced this pull request Nov 27, 2018
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>
@codebytere codebytere mentioned this pull request Nov 27, 2018
rvagg pushed a commit that referenced this pull request Nov 28, 2018
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>
rvagg pushed a commit that referenced this pull request Nov 28, 2018
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>
rvagg pushed a commit that referenced this pull request Nov 28, 2018
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>
rvagg pushed a commit that referenced this pull request Nov 28, 2018
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>
MylesBorins pushed a commit that referenced this pull request Nov 29, 2018
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>
MylesBorins pushed a commit that referenced this pull request Nov 29, 2018
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>
@codebytere codebytere mentioned this pull request Nov 29, 2018
@BethGriggs BethGriggs mentioned this pull request Dec 4, 2018
@Trott Trott deleted the node-js branch January 13, 2022 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.