DscResources icon indicating copy to clipboard operation
DscResources copied to clipboard

Proposal of moving resources to a new (existing) resource module

Open johlju opened this issue 7 years ago • 26 comments

When going through the DSC Resource Kit I have seen a lot of resource modules, many with just a single resource, that could be moved to another repository. Moving these resource would, I think, reduce work when having fewer resource modules to maintain. I also think it would be simpler for the community discuss resources if those that fit together was in the same resource module.

Below is a suggestion how we could move this. It's open for discussion, and please comment on this if I have missed a resource, or if you see any issues with moving a particular resource.

Done Resource Resource(s) Move to Comment
:heavy_check_mark: xPendingReboot xPendingReboot ComputerManagementDsc Discussed in https://github.com/PowerShell/xPendingReboot/issues/12.
:heavy_check_mark: xWinEventLog xWinEventLog ComputerManagementDsc
:heavy_check_mark: xPowerShellExecutionPolicy xPowerShellExecutionPolicy ComputerManagementDsc
:heavy_check_mark: SystemLocaleDsc SystemLocale ComputerManagementDsc ~~Discussed in https://github.com/PowerShell/SystemLocaleDsc/issues/14 and https://github.com/PowerShell/ComputerManagementDsc/issues/50.~~ LanguageDsc is being moved into ComputerManagementDsc (https://github.com/PowerShell/ComputerManagementDsc/pull/160) which will supersede SystemLocaleDsc. Deprecate SystemLocaleDsc once PowerShell/ComputerManagementDsc#160 is merged
In progress xDismFeature xDismFeature ComputerManagementDsc
:heavy_check_mark: xRemoteDesktopAdmin xRemoteDesktopAdmin ComputerManagementDsc PR https://github.com/PowerShell/ComputerManagementDsc/pull/227
-- xWindowsRestore xSystemRestore, xSystemRestorePoint ComputerManagementDsc
-- xWindowsEventForwarding xWEFCollector. xWEFSubscription ComputerManagementDsc
:heavy_check_mark: xTimeZone xTimeZone ComputerManagementDsc
:heavy_check_mark: xSystemSecurity xIEEsc, xUAC ComputerManagementDsc
:heavy_check_mark: xSystemSecurity xFileSystemAccessRule FileSystemDsc (new module)
:heavy_check_mark: xSmbShare xSmbShare ComputerManagementDsc
-- xPhp xPhpProvision xWebAdministration I thought that this resource needs IIS on Windows so that would make it fit into xWebAdministration.

johlju avatar May 10 '18 12:05 johlju

Great list @johlju - very much inline with what I would like to do.

There is a couple of other issues where moving resources into ComputerManagementDSc: https://github.com/PowerShell/ComputerManagementDsc/issues/127 https://github.com/PowerShell/DscResources/issues/288

@ld0614 had suggested that he could add his Language Module to ComputerManagementDsc (https://github.com/ld0614/LanguageDsc), superseding SystemLocaleDsc. @ld0614, are you still interested in doing this? I think the language module contains a lot more functionality than the SystemLocaleDsc one. @Johlju - what do you think?

@ld0614 - your module looks like it has some really great functionality. Needs a few tweaks to make it HQRM, but nothing we can't get sorted easily enough.

PlagueHO avatar May 11 '18 07:05 PlagueHO

@PlagueHO @ld0614 I forgot about the discussion around LanguageDsc. If LangagueDsc makes SystemLocaleDsc obsolete then I think we just deprecate SystemLocaleDsc once LanguageDsc is merged into ComputerManagementDsc (if @ld0614 is still up for it).

johlju avatar May 11 '18 09:05 johlju

I'm still up for merging LangaugeDSC into ComputerManagement, that last time we spoke about it, ComputerManagement was close to changing its name so I was waiting for the name change to avoid needing to rename the LanguageDSC resources just to rename them a month or two later. If thats not really an issue or the work is taking longer than anticipated that I'm quite happy to start the merge process.

ld0614 avatar May 12 '18 12:05 ld0614

Hi @ld0614 - the name change to ComputerManagementDsc is completed :grin: It was even released to the PSGallery. https://github.com/PowerShell/ComputerManagementDsc

PlagueHO avatar May 12 '18 20:05 PlagueHO

Whoops, I missed that one :blush: I'll do a review of the HQRM guidelines tomorrow and raise a PR to start the merge process

ld0614 avatar May 12 '18 21:05 ld0614

This issue has been automatically marked as stale because it has not had activity from the community in the last 30 days. It will be closed if no further activity occurs within 10 days. If the issue is labelled with any of the work labels (e.g bug, enhancement, documentation, or tests) then the issue will not auto-close.

stale[bot] avatar Jun 23 '18 13:06 stale[bot]

Still working on these!

PlagueHO avatar Jun 23 '18 19:06 PlagueHO

Relabeled this one to help wanted so the community know that anyone can help with these, and labeled it enhancement so the issue doesn't autoclose. Two finished so far. 😃

johlju avatar Jun 25 '18 06:06 johlju

Updated the list and marked SystemLocaleDsc with an ❌ since it should not be moved, it is being superseded by LanguageDsc that are pending merge (soon). Although, we should make sure to deprecate SystemLocaleDsc once PR https://github.com/PowerShell/ComputerManagementDsc/pull/160 is merged.

johlju avatar Aug 06 '18 08:08 johlju

xSmbShare has been moved, and xRemoteDesktopAdmin is in progress. If someone else want to move resources, please feel free to do so. Have in mind though that it is a lot of work making the resource high quality (it is often not just moving 1:1).

johlju avatar Jul 04 '19 09:07 johlju

I'm planning on doing xPendingReboot - I think I stuck my hand up for that a while ago. Something I might get onto over the weekend if I can.

PlagueHO avatar Jul 04 '19 09:07 PlagueHO

Getting onto xPendingReboot now.

PlagueHO avatar Aug 10 '19 05:08 PlagueHO

@johlju - can you mark PendingReboot as done? I'll submit a PR to this repo shortly to update the resource list.

PlagueHO avatar Aug 17 '19 10:08 PlagueHO

@johlju - also, xWinEventLog has been completed. So you could update that one in the list too.

PlagueHO avatar Aug 17 '19 10:08 PlagueHO

Done

johlju avatar Aug 17 '19 10:08 johlju

I'll probably move SystemLocaleDsc next (when I get time).

PlagueHO avatar Aug 17 '19 19:08 PlagueHO

Didn’t LanguageDsc override SystemLocaleDsc? See comment column above on that.

johlju avatar Aug 17 '19 19:08 johlju

Better to pick up LanguageDsc PR and move it over the finish line?

johlju avatar Aug 17 '19 19:08 johlju

Yes true - forgot about that one!

PlagueHO avatar Aug 17 '19 19:08 PlagueHO

What's about this one:

https://github.com/microsoft/SChannelDsc

Should we integrate it into ComputerManagementDsc as well?

Outek avatar Oct 31 '19 19:10 Outek

Might have been a good idea, but there are this module that was recently added https://github.com/dsccommunity/SChannelDsc not sure if it the one you linked to that have been moved there. 🤔

johlju avatar Oct 31 '19 19:10 johlju

This seem to be the same.

Outek avatar Oct 31 '19 19:10 Outek

When we have moved ComputerManagementDsc over to DSC Community we could raise the question again? Maybe there are good reasons to keep this one separate. But I could see it in ComputerManagementDsc. 🤔

johlju avatar Oct 31 '19 20:10 johlju

Sure 👍

Outek avatar Oct 31 '19 20:10 Outek

I'm OK with moving it in here but as it is 5 resources and they're all related to security suites it might not be a good idea. It sort of makes sense to keep the 5 of them bundled together on their own I think?

PlagueHO avatar Nov 02 '19 01:11 PlagueHO

There might be a better idea to move it so a "ComputerSecurityDsc" or something instead together with xSystemSecurity. Or call it SystemSecurityDsc and moce SChannelDsc there too. 🤔

The main reason to concatenate modules was to ease the maintaining and release process, not needing to manually release so many modules. But since we are moving the modules over to @dsccommunity and implementing a release pipeline in each module one of the main reason is no longer valid. So if we choose to concatenate modules it would be because of some other reason (also mentioned in the original issue description), for example not needing to download different modules, less modules to maintain, and easier for user to find resources and documentation in less places. 🤔

johlju avatar Nov 02 '19 09:11 johlju