Skip to content

Conversation

@phershbe
Copy link
Contributor

"Long-Term Support" should have a capital "T" according to most style guides if we're making it a proper noun as we are here. It's obviously not super important in the grand scope of the project, but it makes things appear more formal and correct.

@github-actionsgithub-actionsbot added the doc Issues and PRs related to the documentations. label May 29, 2021
@Trott
Copy link
Member

TL;DR: Let's standardize on Long Term Support

Details:

Our style guide for documentation is here: https://github.com/nodejs/node/blob/4c508f51c094085eeb67847b1d2c41b4cd0428dc/doc/guides/doc-style-guide.md

It indicates that for things (like this) that are not covered by it, we follow the Microsoft Style Guide.

The Microsoft Style Guide is a little ambiguous on this. From https://docs.microsoft.com/en-us/style-guide/punctuation/dashes-hyphens/hyphens#capitalization-in-hyphenated-compound-words:

Capitalize any part of a hyphenated compound word that would be capitalized if there were no hyphen.

🤔

But we can get a little more guidance perhaps by looking at actual Microsoft docs. They appear to favor Long Term Support but it's not completely consistent.

Examples using Long Term Support:

https://dotnet.microsoft.com/platform/support/policy/dotnet-core
https://dotnet.microsoft.com/platform/support/policy
https://devblogs.microsoft.com/dotnet/net-core-releases-and-support/
https://devblogs.microsoft.com/dotnet/net-core-2-1-will-reach-end-of-support-on-august-21-2021/

Examples using Long-Term Support:

https://techcommunity.microsoft.com/t5/internet-of-things/new-lts-release-long-term-support-for-azure-iot-hub-sdk-for-net/ba-p/2323148
https://appsource.microsoft.com/en-us/marketplace/consulting-services/dyn365pros.dyn365assist

Examples using long-term support:

https://techcommunity.microsoft.com/t5/windows-it-pro-blog/the-next-windows-10-long-term-servicing-channel-ltsc-release/ba-p/2147232
https://azure.microsoft.com/en-us/updates/csharp-and-java-new-lts-branch/

Examples using long term support:

https://azure.microsoft.com/en-us/updates/the-azure-iot-nodejs-sdk-releases-a-new-long-term-support-lts-release/

Conclustion: Guidance is uncertain stylistically. However, we use Long Term Support more often than the other variants, so let's just standardize on that.

Copy link
Member

@TrottTrott left a comment

Choose a reason for hiding this comment

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

LGTM, but would prefer Long Term Support (see comment).

Trott added a commit to Trott/io.js that referenced this pull request May 29, 2021
Use "Long Term Support" rather than "long term support". Refs: nodejs#38839 (comment)
Trott added a commit to Trott/io.js that referenced this pull request May 29, 2021
Use "Long Term Support" rather than "Long-term support". Refs: nodejs#38839 (comment)
Trott added a commit to Trott/io.js that referenced this pull request May 29, 2021
Use "Long Term Support" rather than "Long-term Support". Refs: nodejs#38839 (comment)
@phershbe
Copy link
ContributorAuthor

@Trott I wanted to comment under your post, but I guess I can't because it was also an approval, I'm new here and am still learning. I agree that we should standardize on "Long Term Support", it's the most common way used by Microsoft and other various companies across the top pages of Google whether you search for "Long-Term Support" or "Long Term Support". @bl-ue Thank you for raising the hyphen issue on top of the capitalization issue that I raised, that was the goal anyway to make the documentation more formal and proper.

@TrottTrott added the fast-track PRs that do not need to wait for 48 hours to land. label May 29, 2021
@Trott
Copy link
Member

@nodejs/documentation

@github-actions
Copy link
Contributor

Fast-track has been requested by @Trott. Please 👍 to approve.

Trott added a commit to Trott/remark-preset-lint-node that referenced this pull request May 29, 2021
"Long-Term Support" should have a capital "T" according to most style guides if we're making it a proper noun as we are here. It's obviously not super important in the grand scope of the project, but it makes things appear more formal and correct. PR-URL: nodejs#38839 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
@TrottTrott merged commit 16ae378 into nodejs:masterMay 30, 2021
@Trott
Copy link
Member

Landed in 16ae378.

Thanks for the contribution! 🎉

Trott added a commit to Trott/io.js that referenced this pull request May 31, 2021
Use "Long Term Support" rather than "long term support". Refs: nodejs#38839 (comment)
Trott added a commit to Trott/io.js that referenced this pull request May 31, 2021
Use "Long Term Support" rather than "Long-term support". Refs: nodejs#38839 (comment)
Trott added a commit to Trott/io.js that referenced this pull request May 31, 2021
Use "Long Term Support" rather than "long term support". Refs: nodejs#38839 (comment) PR-URL: nodejs#38841 Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
Trott added a commit to Trott/io.js that referenced this pull request May 31, 2021
Use "Long Term Support" rather than "Long-term support". Refs: nodejs#38839 (comment) PR-URL: nodejs#38841 Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
danielleadams pushed a commit that referenced this pull request May 31, 2021
"Long-Term Support" should have a capital "T" according to most style guides if we're making it a proper noun as we are here. It's obviously not super important in the grand scope of the project, but it makes things appear more formal and correct. PR-URL: #38839 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
@danielleadamsdanielleadams mentioned this pull request May 31, 2021
danielleadams pushed a commit that referenced this pull request Jun 1, 2021
Use "Long Term Support" rather than "long term support". Refs: #38839 (comment) PR-URL: #38841 Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
danielleadams pushed a commit that referenced this pull request Jun 1, 2021
Use "Long Term Support" rather than "Long-term support". Refs: #38839 (comment) PR-URL: #38841 Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
Trott added a commit to nodejs/remark-preset-lint-node that referenced this pull request Jun 2, 2021
richardlau pushed a commit that referenced this pull request Jul 16, 2021
"Long-Term Support" should have a capital "T" according to most style guides if we're making it a proper noun as we are here. It's obviously not super important in the grand scope of the project, but it makes things appear more formal and correct. PR-URL: #38839 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
richardlau pushed a commit that referenced this pull request Jul 16, 2021
Use "Long Term Support" rather than "long term support". Refs: #38839 (comment) PR-URL: #38841 Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
richardlau pushed a commit that referenced this pull request Jul 16, 2021
Use "Long Term Support" rather than "Long-term support". Refs: #38839 (comment) PR-URL: #38841 Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
richardlau pushed a commit that referenced this pull request Jul 19, 2021
"Long-Term Support" should have a capital "T" according to most style guides if we're making it a proper noun as we are here. It's obviously not super important in the grand scope of the project, but it makes things appear more formal and correct. PR-URL: #38839 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
richardlau pushed a commit that referenced this pull request Jul 19, 2021
Use "Long Term Support" rather than "long term support". Refs: #38839 (comment) PR-URL: #38841 Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
richardlau pushed a commit that referenced this pull request Jul 19, 2021
Use "Long Term Support" rather than "Long-term support". Refs: #38839 (comment) PR-URL: #38841 Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
richardlau pushed a commit that referenced this pull request Jul 20, 2021
"Long-Term Support" should have a capital "T" according to most style guides if we're making it a proper noun as we are here. It's obviously not super important in the grand scope of the project, but it makes things appear more formal and correct. PR-URL: #38839 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
richardlau pushed a commit that referenced this pull request Jul 20, 2021
Use "Long Term Support" rather than "long term support". Refs: #38839 (comment) PR-URL: #38841 Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
richardlau pushed a commit that referenced this pull request Jul 20, 2021
Use "Long Term Support" rather than "Long-term support". Refs: #38839 (comment) PR-URL: #38841 Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
@richardlaurichardlau mentioned this pull request Jul 20, 2021
foxxyz pushed a commit to foxxyz/node that referenced this pull request Oct 18, 2021
"Long-Term Support" should have a capital "T" according to most style guides if we're making it a proper noun as we are here. It's obviously not super important in the grand scope of the project, but it makes things appear more formal and correct. PR-URL: nodejs#38839 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
foxxyz pushed a commit to foxxyz/node that referenced this pull request Oct 18, 2021
Use "Long Term Support" rather than "long term support". Refs: nodejs#38839 (comment) PR-URL: nodejs#38841 Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
foxxyz pushed a commit to foxxyz/node that referenced this pull request Oct 18, 2021
Use "Long Term Support" rather than "Long-term support". Refs: nodejs#38839 (comment) PR-URL: nodejs#38841 Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
Marlyfleitas added a commit to Marlyfleitas/Node-remark-preset-lint that referenced this pull request Aug 26, 2022
patrickm68 added a commit to patrickm68/Node-preset-lint that referenced this pull request Sep 14, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.fast-trackPRs that do not need to wait for 48 hours to land.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@phershbe@Trott@cjihrig@richardlau@RaisinTen@bl-ue