diff --git a/.remarkrc b/.remarkrc index ff2599ff35..ae44c59b10 100644 --- a/.remarkrc +++ b/.remarkrc @@ -14,7 +14,6 @@ ["remark-lint-no-multiple-toplevel-headings", false], ["remark-lint-no-tabs", false], ["remark-lint-no-trailing-spaces", false], - ["remark-lint-prohibited-strings", false], ["remark-lint-unordered-list-marker-style", false] ] } diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 12ff84c641..f3fe8299df 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -2,5 +2,5 @@ The [Node.js Code of Conduct][] applies to this repo. -[node.js code of conduct]: +[Node.js code of conduct]: https://github.com/nodejs/node/blob/master/CODE_OF_CONDUCT.md diff --git a/ModerationPolicy.md b/ModerationPolicy.md index d7c681c7ec..d03970b9dc 100644 --- a/ModerationPolicy.md +++ b/ModerationPolicy.md @@ -2,5 +2,5 @@ The [Node.js Moderation Policy][] applies to this repo. -[node.js moderation policy]: +[Node.js moderation policy]: https://github.com/nodejs/admin/blob/master/Moderation-Policy.md diff --git a/README.md b/README.md index 510a37a7d3..fec14ae1b5 100644 --- a/README.md +++ b/README.md @@ -109,7 +109,7 @@ A quick look at the top-level files and directories you'll see in a Gatsby proje ## 📝 Data Sources -This repository contains no documentation content. Content is pulled from across the Node.js Github Org, Contentful, and other data sources and stitched together into a cohesive website. +This repository contains no documentation content. Content is pulled from across the Node.js GitHub Org, Contentful, and other data sources and stitched together into a cohesive website. ### src/documentation diff --git a/meetings/2018-04-26.md b/meetings/2018-04-26.md index ebabaa87e9..1e602f6996 100644 --- a/meetings/2018-04-26.md +++ b/meetings/2018-04-26.md @@ -37,7 +37,7 @@ Dropped / punted for now. - Two options here: Funds through the foundation for hiring a design firm, or community submissions. - Two-pronged approach, we will start the public call for designers now and also begin the process of requesting funds now as a backup (ETA ~3mo if needed) - Put the infrastructure in place to handle the influx of design submissions -- Make this call available outside of Github +- Make this call available outside of GitHub - Make Call for Proposals ready to launch by date of the Collab Summit. Launch at Collab Summit #### Tech Exploration for In-Browser Node Playground [#12](https://github.com/nodejs/website-redesign/issues/12) diff --git a/src/documentation/0002-node-history/index.md b/src/documentation/0002-node-history/index.md index 790a9436d1..7967d9aaac 100644 --- a/src/documentation/0002-node-history/index.md +++ b/src/documentation/0002-node-history/index.md @@ -19,7 +19,7 @@ In this post, we draw the big picture of Node.js in its history, to put things i JavaScript is a programming language that was created at Netscape as a scripting tool to manipulate web pages inside their browser, [Netscape Navigator](https://en.wikipedia.org/wiki/Netscape_Navigator). -Part of the business model of Netscape was to sell Web Servers, which included an environment called _Netscape LiveWire_ that could create dynamic pages using server-side JavaScript. Unfortunately, _Netscape LiveWire_ wasn't very successful and server-side Javascript wasn't popularized until recently, by the introduction of Node.js. +Part of the business model of Netscape was to sell Web Servers, which included an environment called _Netscape LiveWire_ that could create dynamic pages using server-side JavaScript. Unfortunately, _Netscape LiveWire_ wasn't very successful and server-side JavaScript wasn't popularized until recently, by the introduction of Node.js. One key factor that led to the rise of Node.js was the timing. Just a few years earlier, JavaScript had started to be considered as a more serious language, thanks to "Web 2.0" applications (such as Flickr, Gmail, etc.) that showed the world what a modern experience on the web could be like. diff --git a/src/documentation/0034-javascript-promises/index.md b/src/documentation/0034-javascript-promises/index.md index 81d099f8a8..c36115625d 100644 --- a/src/documentation/0034-javascript-promises/index.md +++ b/src/documentation/0034-javascript-promises/index.md @@ -58,11 +58,11 @@ const isItDoneYet = new Promise((resolve, reject) => { }) ``` -As you can see, the promise checks the `done` global constant, and if that's true, the promise goes to a **resolved** state (since the `resolve` callback was called); otherwise, the `reject` callback is executed, putting the promise in a rejected state. (Note that if one of these functions is never called in the execution path, the promise will remain in a pending state) +As you can see, the promise checks the `done` global constant, and if that's true, the promise goes to a **resolved** state (since the `resolve` callback was called); otherwise, the `reject` callback is executed, putting the promise in a rejected state. (If one of these functions is never called in the execution path, the promise will remain in a pending state) Using `resolve` and `reject`, we can communicate back to the caller what the resulting promise state was, and what to do with it. In the above case we just returned a string, but it could be an object, or `null` as well. Because we've created the promise in the above snippet, it has **already started executing**. This is important to understand what's going on in the section [Consuming a promise](#consuming-a-promise) below. -A more common example you may come across is a technique called **Promisifying**. This technique is a way to be able to use a classic javascript function that takes a callback, and have it return a promise: +A more common example you may come across is a technique called **Promisifying**. This technique is a way to be able to use a classic JavaScript function that takes a callback, and have it return a promise: ```js const fs = require('fs') @@ -84,7 +84,7 @@ getFile('/etc/passwd') .catch(err => console.error(err)) ``` -> note that in recent versions of node.js, you won't have to do this manual conversion for a lot of the API. There is a promisifying function available in the [util module](https://nodejs.org/docs/latest-v11.x/api/util.html#util_util_promisify_original) that will do this for you, given that the function you're promisifying has the correct signature. +> In recent versions of Node.js, you won't have to do this manual conversion for a lot of the API. There is a promisifying function available in the [util module](https://nodejs.org/docs/latest-v11.x/api/util.html#util_util_promisify_original) that will do this for you, given that the function you're promisifying has the correct signature. --- ## Consuming a promise diff --git a/style-guide/0001-voice-and-tone.md b/style-guide/0001-voice-and-tone.md index f96edc6363..76e7e757db 100644 --- a/style-guide/0001-voice-and-tone.md +++ b/style-guide/0001-voice-and-tone.md @@ -49,7 +49,7 @@ to be personal and inviting. To achieve this, we may address our reader like a friend. We might say: _"You're welcome to chat with us about Node.js core features on our -Github issues list!"_ +GitHub issues list!"_ Instead of: _"The GitHub issues list is the place for discussion of Node.js core features."_