From 6745634b8abc051ac75a79888419c4bbc12a58ce Mon Sep 17 00:00:00 2001 From: Megan Bradley Date: Fri, 18 Apr 2025 11:21:58 -0600 Subject: [PATCH 1/4] Update ThirdPartyNotices.md Update links/text per CELA request --- ThirdPartyNotices.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/ThirdPartyNotices.md b/ThirdPartyNotices.md index 8daacc3be461..5d33aa516066 100644 --- a/ThirdPartyNotices.md +++ b/ThirdPartyNotices.md @@ -8,10 +8,9 @@ see the [LICENSE][05] file, and grant you a license to any code in the repositor Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft -names, logos, or trademarks. Microsoft's general trademark guidelines can be found at -[https://go.microsoft.com/fwlink/?LinkID=254653][02]. +names, logos, or trademarks. You can find Microsoft general trademark guidelines at [Microsoft Trademark and Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks). -Privacy information can be found at [https://privacy.microsoft.com][04]. +For privacy information, see [privacy at Microsoft](https://privacy.microsoft.com/en-us/). Microsoft and any contributors reserve all others rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel or otherwise. From e62382f0836b2f7227605e65d2cd759326ac9fcc Mon Sep 17 00:00:00 2001 From: Megan Bradley Date: Fri, 18 Apr 2025 11:35:09 -0600 Subject: [PATCH 2/4] Add Microsoft style guides and configuration files --- .../styles/.vale-config/0-PowerShell-Docs.ini | 23 ++++++++++ .vscode/styles/Microsoft/Gender.yml | 8 ++++ .vscode/styles/Microsoft/GenderBias.yml | 42 +++++++++++++++++++ .vscode/styles/Microsoft/GeneralURL.yml | 11 +++++ .vscode/styles/Microsoft/Percentages.yml | 7 ++++ ThirdPartyNotices.md | 3 +- 6 files changed, 93 insertions(+), 1 deletion(-) create mode 100644 .vscode/styles/.vale-config/0-PowerShell-Docs.ini create mode 100644 .vscode/styles/Microsoft/Gender.yml create mode 100644 .vscode/styles/Microsoft/GenderBias.yml create mode 100644 .vscode/styles/Microsoft/GeneralURL.yml create mode 100644 .vscode/styles/Microsoft/Percentages.yml diff --git a/.vscode/styles/.vale-config/0-PowerShell-Docs.ini b/.vscode/styles/.vale-config/0-PowerShell-Docs.ini new file mode 100644 index 000000000000..e4f60b63b848 --- /dev/null +++ b/.vscode/styles/.vale-config/0-PowerShell-Docs.ini @@ -0,0 +1,23 @@ +StylesPath = styles +Packages = Microsoft, alex + +[*.md] +BasedOnStyles = Vale, Microsoft, alex + +alex.Ablist = NO # Doesn't apply to our content +alex.ProfanityLikely = NO # Doesn't apply to our content +alex.ProfanityMaybe = NO # Doesn't apply to our content +alex.ProfanityUnlikely = NO # Doesn't apply to our content + +Microsoft.HeadingAcronyms = NO # Too noisy for our docset +Microsoft.Headings = NO # Too noisy for our docset +Microsoft.Passive = NO # Too noisy +Microsoft.Negative = NO # Prefer to not use endash +Microsoft.Spacing = NO # Use PowerShell-Docs rule +Microsoft.We = NO # Too noisy when we want to use First Person +Microsoft.Vocab = NO # Too noisy +Microsoft.RangeFormat = NO # Doesn't apply for markdown +Microsoft.Ranges = NO # Doesn't apply for markdown +Microsoft.GeneralURL = NO # Doesn't apply for our audience + +; PowerShell-Docs.Passive = NO # Too noisy \ No newline at end of file diff --git a/.vscode/styles/Microsoft/Gender.yml b/.vscode/styles/Microsoft/Gender.yml new file mode 100644 index 000000000000..0e678e59b563 --- /dev/null +++ b/.vscode/styles/Microsoft/Gender.yml @@ -0,0 +1,8 @@ +extends: existence +message: "Don't use '%s'." +link: https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/styleguide/grammar/nouns-pronouns.md#pronouns-and-gender +level: error +ignorecase: true +tokens: + - he/she + - s/he \ No newline at end of file diff --git a/.vscode/styles/Microsoft/GenderBias.yml b/.vscode/styles/Microsoft/GenderBias.yml new file mode 100644 index 000000000000..2f2b47a8d5fc --- /dev/null +++ b/.vscode/styles/Microsoft/GenderBias.yml @@ -0,0 +1,42 @@ +extends: substitution +message: "Consider using '%s' instead of '%s'." +ignorecase: true +level: error +action: + name: replace +swap: + (?:alumna|alumnus): graduate + (?:alumnae|alumni): graduates + air(?:m[ae]n|wom[ae]n): pilot(s) + anchor(?:m[ae]n|wom[ae]n): anchor(s) + authoress: author + camera(?:m[ae]n|wom[ae]n): camera operator(s) + door(?:m[ae]|wom[ae]n): concierge(s) + draft(?:m[ae]n|wom[ae]n): drafter(s) + fire(?:m[ae]n|wom[ae]n): firefighter(s) + fisher(?:m[ae]n|wom[ae]n): fisher(s) + fresh(?:m[ae]n|wom[ae]n): first-year student(s) + garbage(?:m[ae]n|wom[ae]n): waste collector(s) + lady lawyer: lawyer + ladylike: courteous + mail(?:m[ae]n|wom[ae]n): mail carriers + man and wife: husband and wife + man enough: strong enough + mankind: human kind + manmade: manufactured + manpower: personnel + middle(?:m[ae]n|wom[ae]n): intermediary + news(?:m[ae]n|wom[ae]n): journalist(s) + ombuds(?:man|woman): ombuds + oneupmanship: upstaging + poetess: poet + police(?:m[ae]n|wom[ae]n): police officer(s) + repair(?:m[ae]n|wom[ae]n): technician(s) + sales(?:m[ae]n|wom[ae]n): salesperson or sales people + service(?:m[ae]n|wom[ae]n): soldier(s) + steward(?:ess)?: flight attendant + tribes(?:m[ae]n|wom[ae]n): tribe member(s) + waitress: waiter + woman doctor: doctor + woman scientist[s]?: scientist(s) + work(?:m[ae]n|wom[ae]n): worker(s) \ No newline at end of file diff --git a/.vscode/styles/Microsoft/GeneralURL.yml b/.vscode/styles/Microsoft/GeneralURL.yml new file mode 100644 index 000000000000..04be5f4a22a9 --- /dev/null +++ b/.vscode/styles/Microsoft/GeneralURL.yml @@ -0,0 +1,11 @@ +extends: existence +message: "For a general audience, use 'address' rather than 'URL'." +link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses +level: warning +action: + name: replace + params: + - URL + - address +tokens: + - URL \ No newline at end of file diff --git a/.vscode/styles/Microsoft/Percentages.yml b/.vscode/styles/Microsoft/Percentages.yml new file mode 100644 index 000000000000..db61edf7199b --- /dev/null +++ b/.vscode/styles/Microsoft/Percentages.yml @@ -0,0 +1,7 @@ +extends: existence +message: "Use a numeral plus the units." +link: https://docs.microsoft.com/en-us/style-guide/numbers +nonword: true +level: error +tokens: + - '\b[a-zA-z]+\spercent\b' \ No newline at end of file diff --git a/ThirdPartyNotices.md b/ThirdPartyNotices.md index 5d33aa516066..091e5edd3788 100644 --- a/ThirdPartyNotices.md +++ b/ThirdPartyNotices.md @@ -8,7 +8,8 @@ see the [LICENSE][05] file, and grant you a license to any code in the repositor Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft -names, logos, or trademarks. You can find Microsoft general trademark guidelines at [Microsoft Trademark and Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks). +names, logos, or trademarks. You can find Microsoft general trademark guidelines at +[Microsoft Trademark and Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks). For privacy information, see [privacy at Microsoft](https://privacy.microsoft.com/en-us/). From 04aa60b821107e726823e0d041ab435233596f67 Mon Sep 17 00:00:00 2001 From: Megan Bradley Date: Fri, 18 Apr 2025 12:15:05 -0600 Subject: [PATCH 3/4] Update link references in ThirdPartyNotices.md --- ThirdPartyNotices.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/ThirdPartyNotices.md b/ThirdPartyNotices.md index 091e5edd3788..2036141deab2 100644 --- a/ThirdPartyNotices.md +++ b/ThirdPartyNotices.md @@ -9,16 +9,16 @@ Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft names, logos, or trademarks. You can find Microsoft general trademark guidelines at -[Microsoft Trademark and Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks). +[Microsoft Trademark and Brand Guidelines][02]. -For privacy information, see [privacy at Microsoft](https://privacy.microsoft.com/en-us/). +For privacy information, see [privacy at Microsoft][04]. Microsoft and any contributors reserve all others rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel or otherwise. [01]: https://creativecommons.org/licenses/by/4.0/legalcode -[02]: https://go.microsoft.com/fwlink/?LinkID=254653 +[02]: https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks [03]: https://opensource.org/licenses/MIT [04]: https://privacy.microsoft.com [05]: LICENSE From 8e20cee96f86b312fb74f998204914516f319b78 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Fri, 18 Apr 2025 14:12:22 -0500 Subject: [PATCH 4/4] Update ThirdPartyNotices.md --- .../styles/.vale-config/0-PowerShell-Docs.ini | 23 ---------- .vscode/styles/Microsoft/Gender.yml | 8 ---- .vscode/styles/Microsoft/GenderBias.yml | 42 ------------------- .vscode/styles/Microsoft/GeneralURL.yml | 11 ----- .vscode/styles/Microsoft/Percentages.yml | 7 ---- ThirdPartyNotices.md | 6 +-- 6 files changed, 3 insertions(+), 94 deletions(-) delete mode 100644 .vscode/styles/.vale-config/0-PowerShell-Docs.ini delete mode 100644 .vscode/styles/Microsoft/Gender.yml delete mode 100644 .vscode/styles/Microsoft/GenderBias.yml delete mode 100644 .vscode/styles/Microsoft/GeneralURL.yml delete mode 100644 .vscode/styles/Microsoft/Percentages.yml diff --git a/.vscode/styles/.vale-config/0-PowerShell-Docs.ini b/.vscode/styles/.vale-config/0-PowerShell-Docs.ini deleted file mode 100644 index e4f60b63b848..000000000000 --- a/.vscode/styles/.vale-config/0-PowerShell-Docs.ini +++ /dev/null @@ -1,23 +0,0 @@ -StylesPath = styles -Packages = Microsoft, alex - -[*.md] -BasedOnStyles = Vale, Microsoft, alex - -alex.Ablist = NO # Doesn't apply to our content -alex.ProfanityLikely = NO # Doesn't apply to our content -alex.ProfanityMaybe = NO # Doesn't apply to our content -alex.ProfanityUnlikely = NO # Doesn't apply to our content - -Microsoft.HeadingAcronyms = NO # Too noisy for our docset -Microsoft.Headings = NO # Too noisy for our docset -Microsoft.Passive = NO # Too noisy -Microsoft.Negative = NO # Prefer to not use endash -Microsoft.Spacing = NO # Use PowerShell-Docs rule -Microsoft.We = NO # Too noisy when we want to use First Person -Microsoft.Vocab = NO # Too noisy -Microsoft.RangeFormat = NO # Doesn't apply for markdown -Microsoft.Ranges = NO # Doesn't apply for markdown -Microsoft.GeneralURL = NO # Doesn't apply for our audience - -; PowerShell-Docs.Passive = NO # Too noisy \ No newline at end of file diff --git a/.vscode/styles/Microsoft/Gender.yml b/.vscode/styles/Microsoft/Gender.yml deleted file mode 100644 index 0e678e59b563..000000000000 --- a/.vscode/styles/Microsoft/Gender.yml +++ /dev/null @@ -1,8 +0,0 @@ -extends: existence -message: "Don't use '%s'." -link: https://github.com/MicrosoftDocs/microsoft-style-guide/blob/master/styleguide/grammar/nouns-pronouns.md#pronouns-and-gender -level: error -ignorecase: true -tokens: - - he/she - - s/he \ No newline at end of file diff --git a/.vscode/styles/Microsoft/GenderBias.yml b/.vscode/styles/Microsoft/GenderBias.yml deleted file mode 100644 index 2f2b47a8d5fc..000000000000 --- a/.vscode/styles/Microsoft/GenderBias.yml +++ /dev/null @@ -1,42 +0,0 @@ -extends: substitution -message: "Consider using '%s' instead of '%s'." -ignorecase: true -level: error -action: - name: replace -swap: - (?:alumna|alumnus): graduate - (?:alumnae|alumni): graduates - air(?:m[ae]n|wom[ae]n): pilot(s) - anchor(?:m[ae]n|wom[ae]n): anchor(s) - authoress: author - camera(?:m[ae]n|wom[ae]n): camera operator(s) - door(?:m[ae]|wom[ae]n): concierge(s) - draft(?:m[ae]n|wom[ae]n): drafter(s) - fire(?:m[ae]n|wom[ae]n): firefighter(s) - fisher(?:m[ae]n|wom[ae]n): fisher(s) - fresh(?:m[ae]n|wom[ae]n): first-year student(s) - garbage(?:m[ae]n|wom[ae]n): waste collector(s) - lady lawyer: lawyer - ladylike: courteous - mail(?:m[ae]n|wom[ae]n): mail carriers - man and wife: husband and wife - man enough: strong enough - mankind: human kind - manmade: manufactured - manpower: personnel - middle(?:m[ae]n|wom[ae]n): intermediary - news(?:m[ae]n|wom[ae]n): journalist(s) - ombuds(?:man|woman): ombuds - oneupmanship: upstaging - poetess: poet - police(?:m[ae]n|wom[ae]n): police officer(s) - repair(?:m[ae]n|wom[ae]n): technician(s) - sales(?:m[ae]n|wom[ae]n): salesperson or sales people - service(?:m[ae]n|wom[ae]n): soldier(s) - steward(?:ess)?: flight attendant - tribes(?:m[ae]n|wom[ae]n): tribe member(s) - waitress: waiter - woman doctor: doctor - woman scientist[s]?: scientist(s) - work(?:m[ae]n|wom[ae]n): worker(s) \ No newline at end of file diff --git a/.vscode/styles/Microsoft/GeneralURL.yml b/.vscode/styles/Microsoft/GeneralURL.yml deleted file mode 100644 index 04be5f4a22a9..000000000000 --- a/.vscode/styles/Microsoft/GeneralURL.yml +++ /dev/null @@ -1,11 +0,0 @@ -extends: existence -message: "For a general audience, use 'address' rather than 'URL'." -link: https://docs.microsoft.com/en-us/style-guide/urls-web-addresses -level: warning -action: - name: replace - params: - - URL - - address -tokens: - - URL \ No newline at end of file diff --git a/.vscode/styles/Microsoft/Percentages.yml b/.vscode/styles/Microsoft/Percentages.yml deleted file mode 100644 index db61edf7199b..000000000000 --- a/.vscode/styles/Microsoft/Percentages.yml +++ /dev/null @@ -1,7 +0,0 @@ -extends: existence -message: "Use a numeral plus the units." -link: https://docs.microsoft.com/en-us/style-guide/numbers -nonword: true -level: error -tokens: - - '\b[a-zA-z]+\spercent\b' \ No newline at end of file diff --git a/ThirdPartyNotices.md b/ThirdPartyNotices.md index 2036141deab2..0b62e7b275fd 100644 --- a/ThirdPartyNotices.md +++ b/ThirdPartyNotices.md @@ -8,17 +8,17 @@ see the [LICENSE][05] file, and grant you a license to any code in the repositor Microsoft, Windows, Microsoft Azure and/or other Microsoft products and services referenced in the documentation may be either trademarks or registered trademarks of Microsoft in the United States and/or other countries. The licenses for this project do not grant you rights to use any Microsoft -names, logos, or trademarks. You can find Microsoft general trademark guidelines at +names, logos, or trademarks. You can find Microsoft general trademark guidelines at [Microsoft Trademark and Brand Guidelines][02]. -For privacy information, see [privacy at Microsoft][04]. +For privacy information, see [Privacy at Microsoft][04]. Microsoft and any contributors reserve all others rights, whether under their respective copyrights, patents, or trademarks, whether by implication, estoppel or otherwise. [01]: https://creativecommons.org/licenses/by/4.0/legalcode -[02]: https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks +[02]: https://www.microsoft.com/legal/intellectualproperty/trademarks [03]: https://opensource.org/licenses/MIT [04]: https://privacy.microsoft.com [05]: LICENSE