xActiveDirectory: Add Auto-Generated 'about_<DSCResource>.help.txt' Files for all Resources

[X-Guardian]

Pull Request (PR) description

This PR adds auto-generated about_help files for each resource to the resource specific en-US directory. This will be displayed on PowerShell when running Get-Help and the specific DSC resource name.

These files were generated with the modified New-DscResourcePowerShellHelp function from this PR: PowerShell/DscResource.Tests#325.

This Pull Request (PR) fixes the following issues

• Fixes xActiveDirectory: Add 'about_<DSCResource>.help.txt' Files for each Resource #404

Task list

• Added an entry under the Unreleased section in the CHANGELOG.md.
  Entry should say what was changed, and how that affects users (if applicable).
• Resource documentation added/updated in resource directory README.md.
• Resource parameter descriptions added/updated in schema.mof
  and comment-based help.
• Comment-based help added/updated.
• Localization strings added/updated in all localization files as appropriate.
• Examples appropriately added/updated.
• Unit tests added/updated. See DSC Resource Testing Guidelines.
• Integration tests added/updated (where possible). See DSC Resource Testing Guidelines.
• New/changed code adheres to DSC Resource Style Guidelines and Best Practices.

---

This change is 

[codecov-io]

Codecov Report

Merging #405 into dev will not change coverage.
The diff coverage is n/a.

@@         Coverage Diff         @@
##            dev   #405   +/-   ##
===================================
  Coverage    92%    92%           
===================================
  Files        20     20           
  Lines      2538   2538           
  Branches     10     10           
===================================
  Hits       2345   2345           
  Misses      183    183           
  Partials     10     10

[johlju]

Added comments that maybe need to be addressed in the function in DscResource.Tests?

Reviewed 19 of 19 files at r1, 1 of 1 files at r2.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @X-Guardian)

---

DSCResources/MSFT_xADComputer/en-US/about_xADComputer.help.txt, line 4 at r2 (raw file):

 Description

This does not get indented. Should it? Should it be .DESCRIPTION even?

---

DSCResources/MSFT_xADComputer/en-US/about_xADComputer.help.txt, line 98 at r2 (raw file):

.Example 1

Maybe this should be .EXAMPLE 1 (upper-case) to be consequent with the rest?

[X-Guardian]

Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @johlju)

---

DSCResources/MSFT_xADComputer/en-US/about_xADComputer.help.txt, line 4 at r2 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

 Description

This does not get indented. Should it? Should it be .DESCRIPTION even?

This was an issue in the New-DscResourcePowerShellHelp function. I've fixed it as part of PR PowerShell/DscResource.Tests#325 and committed new help files.

---

DSCResources/MSFT_xADComputer/en-US/about_xADComputer.help.txt, line 98 at r2 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

.Example 1

Maybe this should be .EXAMPLE 1 (upper-case) to be consequent with the rest?

This is output from the Get-DscResourceHelpExampleContent function and would need to be changed there.

[johlju]

Reviewed 19 of 19 files at r3.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @X-Guardian)

---

DSCResources/MSFT_xADComputer/en-US/about_xADComputer.help.txt, line 98 at r2 (raw file):

Previously, X-Guardian (Simon Heather) wrote…

This is output from the Get-DscResourceHelpExampleContent function and would need to be changed there.

I think we should change it there, to have upper-case for all these. Or submit an issue to resolve it there. Can be non-blocking for this, but waiting for your feedback if you will resolve it and oush new files again.

[X-Guardian]

Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @johlju)

---

DSCResources/MSFT_xADComputer/en-US/about_xADComputer.help.txt, line 98 at r2 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

I think we should change it there, to have upper-case for all these. Or submit an issue to resolve it there. Can be non-blocking for this, but waiting for your feedback if you will resolve it and oush new files again.

Agreed. Can you raise an issue in DSCResource.Tests for this and we can get it sorted. This PR can wait till its done and then I'll recreate the help files.

[johlju]

Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @X-Guardian)

---

DSCResources/MSFT_xADComputer/en-US/about_xADComputer.help.txt, line 98 at r2 (raw file):

Previously, X-Guardian (Simon Heather) wrote…

Agreed. Can you raise an issue in DSCResource.Tests for this and we can get it sorted. This PR can wait till its done and then I'll recreate the help files.

Submitted the issue PowerShell/DscResource.Tests#329. I leave this comment as blocking since you suggested that we can keep this open until it is resolved in DscResource.Tests.

[X-Guardian]

Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @johlju)

---

DSCResources/MSFT_xADComputer/en-US/about_xADComputer.help.txt, line 98 at r2 (raw file):

Previously, johlju (Johan Ljunggren) wrote…

Submitted the issue PowerShell/DscResource.Tests#329. I leave this comment as blocking since you suggested that we can keep this open until it is resolved in DscResource.Tests.

Cheers @johlju, that's fine. I'll take a look at that issue.

[X-Guardian]

Reviewable status: 1 of 20 files reviewed, 1 unresolved discussion (waiting on @johlju)

---

DSCResources/MSFT_xADComputer/en-US/about_xADComputer.help.txt, line 98 at r2 (raw file):

Previously, X-Guardian (Simon Heather) wrote…

Cheers @johlju, that's fine. I'll take a look at that issue.

Done. Capitilized .EXAMPLE, and removed a blank line after .DESCRIPTION

[johlju]

Reviewed 19 of 19 files at r4.
Reviewable status: complete! all files reviewed, all discussions resolved