Merge pull request #3 from xoap-io/dev

feat: multiple adjustments to README.md and template

Author: ssokolic

.gitattributes

@@ -31,22 +31,6 @@ repos:
       - id: no-commit-to-branch
         args:
           - -b main
-  - repo: https://github.com/antonbabenko/pre-commit-terraform
-    rev: v1.72.1
-    hooks:
-      - id: terraform_fmt
-      - id: terraform_tflint
-      - id: terraform_docs
-        args:
-          - --hook-config=--path-to-file=README.md
-          - --hook-config=--add-to-existing-file=true
-          - --hook-config=--create-file-if-not-exist=true
-      - id: terraform_tfsec
-      - id: terraform_validate
-  - repo: https://github.com/Checkmarx/kics
-    rev: v1.5.9
-    hooks:
-      - id: kics
   - repo: https://github.com/sirosen/check-jsonschema
     rev: 0.15.1
     hooks:

.gitignore

@@ -23,7 +23,7 @@ param (
 $globalPrefix = "XOAP"
 $curDirectory = Resolve-Path .\
 $templatePath = Join-Path $curDirectory "templates"
-$rootModulePath = Resolve-Path ..\..\
+$rootModulePath = Resolve-Path ..\
 $Module = "${globalPrefix}${Module}DSC"
 $modulePath = Join-Path $rootModulePath "$Module"
 $moduleVersionPath = Join-Path $modulePath $Version
@@ -65,7 +65,7 @@ else
     $template = Join-Path $templatePath "composite_resource"
     $moduleData = @{
         project_name = "${Ressource}"
-        version = "1.0.0"
+        version = "0.0.1"
         company = $Company
         TemplatePath = "$template"
         DestinationPath = "$ressourcePath"

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 # Getting started
 
-This scripts are used to easly create new dsc composite ressources.
+This scripts are used to easly create new XOAP PowerShell DSC composite resources.
 
 ## Prerequisites
 
@@ -13,25 +13,28 @@ Import-Module Plaster
 
 ## Creating new modules
 
-Modules will be automatically created once you are creating a new composite ressource.
+Modules will be automatically created once you are creating a new composite resource.
 
-## Creating new composite ressources
+## Creating new composite resources
 
-Composite ressources can easily be deployed via the invocation of
+Composite resources can easily be deployed via the invocation of:
 
 ´´PowerShell
- .\New-CompositeRessource.ps1
- ``
+.\New-CompositeResource.ps1
+``
 
 with parameters
 
 ´´PowerShell
- .\New-CompositeRessource.ps1 -Module W2K19DC1903Baseline -Version 1.0.0 -Ressource ScheduledTasks
- ``
+.\New-CompositeResource.ps1 -Module Template -Version 1.0.0 -Resource DSC_Template
+``
+
+The prefix "XOAP" is automatically added and the postfix "DSC" as well.
+
 The parameter list is as followed:
 
-|Parameter      |Description                                |Note
-| ------------- | ----------------------------------------- | ------------- |
-|Module         |Name of the outer module part              | -
-|Version        |Target version of the module               | -
-|Ressource      |The name of the ressource /config part     | -
+| Parameter | Description                           | Note |
+| --------- | ------------------------------------- | ---- |
+| Module    | Name of the outer module part         | -    |
+| Version   | Target version of the module          | -    |
+| Resource  | The name of the resource /config part | -    |

LICENSE

@@ -1,5 +1,5 @@
 #
-# Module manifest for module 'ScheduledTasks'
+# Module manifest for module 'Template'
 #
 # Generated by: XOAP
 #
@@ -9,7 +9,7 @@
 @{
 
 # Script module or binary module file associated with this manifest.
-RootModule = 'ScheduledTasks.schema.psm1'
+RootModule = 'Template.schema.psm1'
 
 # Version number of this module.
 ModuleVersion = '1.0.0'
@@ -30,7 +30,7 @@ CompanyName = 'XOAP'
 Copyright = '(c) XOAP.io. All rights reserved.'
 
 # Description of the functionality provided by this module
-Description = 'ScheduledTasks'
+Description = 'Template'
 
 # Minimum version of the PowerShell engine required by this module
 # PowerShellVersion = ''
@@ -94,14 +94,14 @@ PrivateData = @{
 
     PSData = @{
 
-        # Tags applied to this module. These help with module discovery in online galleries.
-        # Tags = @()
+    # Tags applied to this module. These help with module discovery in online galleries.
+        Tags = @(DSC, XOAP)
 
         # A URL to the license for this module.
         # LicenseUri = ''
 
         # A URL to the main website for this project.
-        # ProjectUri = ''
+        ProjectUri = 'https://xoap.io'
 
         # A URL to an icon representing this module.
         # IconUri = ''

New-CompositeRessource.ps1

@@ -1,14 +1,13 @@
-configuration ScheduledTasks
+configuration Template
 {
     [CmdletBinding()]
     param (
         [Parameter()]
         [TypeName]
         $ParameterName
     )
+    Import-DSCResource -ModuleName xPSDesiredStateConfiguration
 
-    #Import-DSCResource -ModuleName xPSDesiredStateConfiguration
-    #
     #xRegistry disableInsecureCipher_a
     #{
     #    Key       = 'HKLM:\SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL\Ciphers\DES 56/56'
@@ -18,5 +17,4 @@ configuration ScheduledTasks
     #    Ensure    = 'Present'
     #    Force     = $true
     #}
-
 }

Readme.md

@@ -1,18 +1,17 @@
-configuration default
+configuration Template
 {
     param
     (
         # Target nodes to apply the configuration
         [string[]]$NodeName = 'localhost'
     )
 
-    Import-Module XOAPBaselineW2k19DSC
-    Import-DSCResource -ModuleName XOAPBaselineW2k19DSC
+    Import-Module XOAPTemplateDSC
+    Import-DSCResource -ModuleName XOAPTemplateDSC
 
     Node $NodeName
     {
-
-        $moduleRoot = [io.path]::GetDirectoryName((Get-Module XOAPBaselineW2k19DSC).Path)
+        $moduleRoot = [io.path]::GetDirectoryName((Get-Module XOAPTemplateDSC).Path)
         $examples = "$moduleRoot\Examples"
 
         # Install the IIS role
@@ -21,6 +20,5 @@ configuration default
             Ensure          = "Present"
             Name            = "Web-Server"
         }
-
     }
 }