doc: add glossary.md by gengjiawen · Pull Request #27517 · nodejs/node

gengjiawen · 2019-05-01T14:51:29Z

Related issue: #26718.

Todo

I want to add primordials, but I have no idea what it means.

cc @refack @BridgeAR

Checklist

make -j4 test (UNIX), or vcbuild test (Windows) passes
tests and/or benchmarks are included
documentation is changed or added
commit message follows commit guidelines

mscdex · 2019-05-01T14:56:17Z

Some of these terms are already defined in the linked Chromium glossary.

Trott · 2019-05-01T14:56:30Z

Can you move this under doc/?

gengjiawen · 2019-05-01T14:59:31Z

Some of these terms are already defined in the linked Chromium glossary.

I do it deliberately because LGTM is too common.

gengjiawen · 2019-05-01T15:05:01Z

Can you move this under doc/?

My thought is that it's very basic doc, so I would like to be in the root directory.
I am okay either way.

gengjiawen · 2019-05-01T15:05:46Z

Do we need to add TSC to this ?

BridgeAR · 2019-05-03T12:13:29Z

Do we need to add TSC to this ?

If we add a glossary, I'd say it should contain references to all acronyms we use.

My thought is that it's very basic doc, so I would like to be in the root directory.

I am on the edge about this. I see the benefit of having in the root dir but we already have to many files in there (we might want to move some other files like the CPP style guide. That does not seem to belong into the root dir. The collaborator guide could likely also be moved since it's intention is mainly for collaborators and not for everyone).

I want to add primordials, but I have no idea what it means.

Those are pristine built-ins that are not effected by prototype pollution and tampering with built-ins.

refack · 2019-05-03T13:28:55Z

Can you move this under doc/?

My intuition is that this should be in https://github.com/nodejs/node/blob/master/COLLABORATOR_GUIDE.md (prbly at the end)

refack · 2019-05-03T13:32:47Z

gengjiawen · 2019-05-03T16:22:29Z

gengjiawen · 2019-05-12T12:11:34Z

@refack @BridgeAR Can you review this, thanks.

jasnell · 2019-05-12T22:28:01Z

Not sure this needs to be in a separate document at the top level. This can be added as a section of the contributor guide.

BridgeAR

The documentation itself is LGTM. I leave the decision about the location to others.

Trott

Terms should be in alphabetical order, I would think?

gengjiawen · 2019-05-15T03:44:01Z

Not sure this needs to be in a separate document at the top level. This can be added as a section of the contributor guide.

It's more clear when it in one file such as chrome did.
Also this file may grow a little longer.

gengjiawen · 2019-05-15T03:46:57Z

Is is possible to write a test for this new handler? I think you can just write some OOB in WAT, compile it to wasm, and load it in a child process and check SIGSEGV?

FROM #27246 (review)

So what's OOB and WAT ? Should we add those two. cc @joyeecheung

gengjiawen · 2019-05-15T14:25:16Z

Terms should be in alphabetical order, I would think?

Now sorted. (Using vim sort)

Trott · 2019-05-16T14:57:22Z

Is is possible to write a test for this new handler? I think you can just write some OOB in WAT, compile it to wasm, and load it in a child process and check SIGSEGV?

FROM #27246 (review)

So what's OOB and WAT ? Should we add those two. cc @joyeecheung

I'd avoid adding that (and, probably, a glossary at all, to be honest, but I won't block if others think this is a good idea). These terms are not Node.js-specific. People can use search engines and/or we can link to a general glossary that has these sorts of things. We can't include every piece of information imaginable in our source code, and trying will make the important stuff harder to find. We need to curate our information. (Why not include handler? SIGSEGV? Wasm? Child process? Process? Web server? Test?)

Realistically, I suspect people aren't going to look in the glossary anyway. They're going to ask, "What is WAT?"

entries alphabetized

Trott · 2019-05-16T15:01:50Z

I guess I'd be more inclined to support this if we either just linked to Chrome's glossary (why duplicate the work?) or held the glossary to be strictly Node.js-specific terms or things very closely tied to Node.js. None of these except maybe primordials is specific to Node.js.

gireeshpunathil · 2019-12-24T09:55:24Z

IMO, the ones mentioned in #27517 (comment) are going to be really useful for new comers, irrespective of their sole origin is our project or not, (and in some case how trivial those may look), but those are heavily used across the code and doc. Here are some more:

ABI, ASAP, ASM, ASYNC, BE, CI, CITGM, CJS, CLDR, CLI, CMD, CVE, ECMA, ENV, EOF, EOL, ESM, ETW, FD, FFDC, FIPS, FS, ICU, IPC, JIT, LTS, MDN, OOB, OOM, OSX, PPC, RAII, REPL, RFC, RSS, RTTI, SMP, TSC, WASI, WASM, WG, WHATWG

nodejs-github-bot · 2020-02-13T13:01:18Z

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

lundibundi · 2020-02-13T13:27:13Z

@@ -0,0 +1,16 @@
+You may also need to check https://chromium.googlesource.com/chromiumos/docs/+/master/glossary.md.


Nit: shouldn't this go at the bottom of the file, as it's meant to be an addition to this file based in the text?

lundibundi · 2020-02-13T13:30:02Z

+* PTAL: Please take a look.
+* RSLGTM: "Rubber-stamp looks good to me". The reviewer approving without doing
+  a full code review.
+* TSC: Technical Steering Committee. Detailed info see


Nit:

Suggested change

* TSC: Technical Steering Committee. Detailed info see

* TSC: Technical Steering Committee. Detailed info can be found here

Or

Suggested change

* TSC: Technical Steering Committee. Detailed info see

* TSC: Technical Steering Committee. For detailed info see

lundibundi · 2020-02-13T13:32:54Z

+* WIP: "Work In Progress" - e.g. a patch that's not finished, but may be worth
+  an early look.
+* WPT: [web-platform-tests](https://github.com/web-platform-tests/wpt)
+* godbolt: [Compiler Explorer](https://godbolt.org/) run compilers interactively


Nit:

Suggested change

* godbolt: [Compiler Explorer](https://godbolt.org/) run compilers interactively

* godbolt: [Compiler Explorer](https://godbolt.org/) allows to run compilers interactively

PR-URL: #27517 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Denys Otrishko <shishugi@gmail.com>

gengjiawen · 2020-02-14T03:28:25Z

Landed in 13c05cd

gengjiawen · 2020-02-14T03:29:01Z

@lundibundi I will open a pr to resolve this and add more items.

PR-URL: #27517 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Denys Otrishko <shishugi@gmail.com>

nodejs-github-bot added the doc Issues and PRs related to the documentations. label May 1, 2019

BridgeAR reviewed May 3, 2019

View reviewed changes

Comment thread glossary.md Outdated

gengjiawen force-pushed the glossary branch from 49b8797 to 9f241e3 Compare May 3, 2019 16:21

gengjiawen marked this pull request as ready for review May 8, 2019 08:23

BridgeAR reviewed May 13, 2019

View reviewed changes

Trott previously requested changes May 13, 2019

View reviewed changes

gengjiawen force-pushed the glossary branch from 9f241e3 to 850973c Compare May 15, 2019 14:24

Trott force-pushed the master branch from 1ecc406 to 49cf67e Compare September 17, 2019 16:51

jasnell reviewed Dec 24, 2019

View reviewed changes

Comment thread glossary.md Outdated

devnexen force-pushed the master branch from e8a4568 to 5289f80 Compare December 26, 2019 19:46

gireeshpunathil approved these changes Jan 7, 2020

View reviewed changes

This comment has been minimized.

Sign in to view

BridgeAR approved these changes Jan 12, 2020

View reviewed changes

BridgeAR reviewed Jan 12, 2020

View reviewed changes

Comment thread glossary.md Outdated

Comment thread glossary.md Outdated

Comment thread glossary.md Outdated

Comment thread glossary.md Outdated

Comment thread glossary.md Outdated

Comment thread glossary.md Outdated

gengjiawen force-pushed the glossary branch 2 times, most recently from 5161e3e to f08236d Compare January 23, 2020 06:13

This comment has been minimized.

Sign in to view

gengjiawen added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jan 23, 2020

doc: add glossary.md

f5b5b41

gengjiawen force-pushed the glossary branch from f08236d to f5b5b41 Compare January 24, 2020 04:08

This comment has been minimized.

Sign in to view

lundibundi approved these changes Feb 13, 2020

View reviewed changes

gengjiawen added a commit that referenced this pull request Feb 14, 2020

doc: add glossary.md

13c05cd

PR-URL: #27517 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Denys Otrishko <shishugi@gmail.com>

gengjiawen closed this Feb 14, 2020

gengjiawen reopened this Feb 14, 2020

gengjiawen closed this Feb 14, 2020

gengjiawen deleted the glossary branch February 14, 2020 03:30

codebytere pushed a commit that referenced this pull request Feb 17, 2020

doc: add glossary.md

2cd8461

PR-URL: #27517 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Denys Otrishko <shishugi@gmail.com>

codebytere mentioned this pull request Feb 17, 2020

v13.9.0 proposal #31837

Merged

codebytere pushed a commit that referenced this pull request Mar 15, 2020

doc: add glossary.md

d271cdb

PR-URL: #27517 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Denys Otrishko <shishugi@gmail.com>

codebytere pushed a commit that referenced this pull request Mar 17, 2020

doc: add glossary.md

832d8a5

PR-URL: #27517 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Denys Otrishko <shishugi@gmail.com>

codebytere mentioned this pull request Mar 17, 2020

v12.16.2 proposal #32313

Merged

codebytere pushed a commit that referenced this pull request Mar 30, 2020

doc: add glossary.md

82defc0

PR-URL: #27517 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Denys Otrishko <shishugi@gmail.com>

		@@ -0,0 +1,16 @@
		You may also need to check https://chromium.googlesource.com/chromiumos/docs/+/master/glossary.md.

	* TSC: Technical Steering Committee. Detailed info see
	* TSC: Technical Steering Committee. Detailed info can be found here

	* TSC: Technical Steering Committee. Detailed info see
	* TSC: Technical Steering Committee. For detailed info see

	* godbolt: [Compiler Explorer](https://godbolt.org/) run compilers interactively
	* godbolt: [Compiler Explorer](https://godbolt.org/) allows to run compilers interactively

Uh oh!

Conversation

gengjiawen commented May 1, 2019

Todo

Checklist

Uh oh!

mscdex commented May 1, 2019

Uh oh!

Trott commented May 1, 2019

Uh oh!

gengjiawen commented May 1, 2019

Uh oh!

gengjiawen commented May 1, 2019

Uh oh!

gengjiawen commented May 1, 2019

Uh oh!

Uh oh!

BridgeAR commented May 3, 2019

Uh oh!

refack commented May 3, 2019

Uh oh!

refack commented May 3, 2019

Uh oh!

gengjiawen commented May 3, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gengjiawen commented May 12, 2019

Uh oh!

jasnell commented May 12, 2019

Uh oh!

BridgeAR left a comment

Choose a reason for hiding this comment

Uh oh!

Trott left a comment

Choose a reason for hiding this comment

Uh oh!

gengjiawen commented May 15, 2019

Uh oh!

gengjiawen commented May 15, 2019

Uh oh!

gengjiawen commented May 15, 2019

Uh oh!

Trott commented May 16, 2019

Uh oh!

Trott commented May 16, 2019

Uh oh!

gireeshpunathil commented Dec 24, 2019

Uh oh!

Uh oh!

This comment has been minimized.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

nodejs-github-bot commented Feb 13, 2020

Uh oh!

lundibundi Feb 13, 2020

Choose a reason for hiding this comment

Uh oh!

lundibundi Feb 13, 2020

Choose a reason for hiding this comment

Uh oh!

lundibundi Feb 13, 2020

Choose a reason for hiding this comment

Uh oh!

gengjiawen commented Feb 14, 2020

Uh oh!

gengjiawen commented Feb 14, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

gengjiawen commented May 3, 2019 •

edited

Loading

gengjiawen commented Feb 14, 2020 •

edited

Loading