Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ActiveDirectoryDsc: All examples should be prefixed with resource name #416

Closed
johlju opened this issue Jul 7, 2019 · 1 comment · Fixed by #450
Closed

ActiveDirectoryDsc: All examples should be prefixed with resource name #416

johlju opened this issue Jul 7, 2019 · 1 comment · Fixed by #450
Labels
enhancement The issue is an enhancement request. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub high priority The issue or PR should be resolved first. It is of less priority than the label 'Blocking Release'.
Projects
All issues and PR's

Comments

@johlju
Copy link
Member

johlju commented Jul 7, 2019

When the examples are deployed to the PowerShell Gallery it will not be easy to find examples if they are not prefixed with the resource name.

For example the example 1-AddDomainControllerToDomainMinimal_Config.ps1 should instead be named 1-xADDomainController_AddDomainControllerToDomainMinimal_Config.ps1. It will then be easy for users to search for xADDomainController and get all the examples for that resource.

When the filename changes, the configuration name must also change to have the prefix as configuration name and filename must be same (with the exception of the prefix number '1-').

See examples in ComputerManagementDsc https://github.com/PowerShell/ComputerManagementDsc/tree/dev/Examples/Resources/Computer.
@johlju johlju added enhancement The issue is an enhancement request. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub help wanted The issue is up for grabs for anyone in the community. labels Jul 7, 2019
@johlju johlju added this to To do in All issues and PR's via automation Jul 7, 2019
@johlju johlju added the high priority The issue or PR should be resolved first. It is of less priority than the label 'Blocking Release'. label Jul 25, 2019
@johlju
Copy link
Member Author

johlju commented Jul 25, 2019

We should resolve this as soon as the module has been renamed (issue #312 is closed).

johlju added a commit to johlju/ActiveDirectoryDsc that referenced this issue Jul 28, 2019
@johlju
Changes to ActiveDirectoryDsc
4385556 
- Updated all the examples files to be prefixed with the resource
  name so they are more easily discovered in PowerShell Gallery and
  Azure Automation (issue dsccommunity#416).
@johlju johlju mentioned this issue Jul 28, 2019
Merged
9 tasks
@johlju johlju added in progress The issue is being actively worked on by someone. and removed help wanted The issue is up for grabs for anyone in the community. labels Jul 28, 2019
@johlju johlju changed the title xActiveDirectory: All examples should be prefixed with resource name ActiveDirectoryDsc: All examples should be prefixed with resource name Jul 28, 2019
johlju added a commit to johlju/ActiveDirectoryDsc that referenced this issue Jul 29, 2019
@johlju
Changes to ActiveDirectoryDsc
08297fb 
- Updated all the examples files to be prefixed with the resource
  name so they are more easily discovered in PowerShell Gallery and
  Azure Automation (issue dsccommunity#416).
All issues and PR's automation moved this from To do to Done Jul 29, 2019
johlju added a commit that referenced this issue Jul 29, 2019
@johlju
ActiveDirectoryDsc: Examples prefixed with resource name (#450)
a2a7c4c 
- Changes to ActiveDirectoryDsc
  - Updated all the examples files to be prefixed with the resource
    name so they are more easily discovered in PowerShell Gallery and
    Azure Automation (issue #416).
@johlju johlju removed the in progress The issue is being actively worked on by someone. label Jul 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement The issue is an enhancement request. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub high priority The issue or PR should be resolved first. It is of less priority than the label 'Blocking Release'.
Projects
All issues and PR's
  
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

ActiveDirectoryDsc: Examples prefixed with resource name johlju/ActiveDirectoryDsc
1 participant
@johlju