Skip to content

Commit 68fb921

Browse files
committed
Updated formatting and wording to improve Acrolinx score
1 parent b2854ba commit 68fb921

File tree

1 file changed

+42
-18
lines changed

1 file changed

+42
-18
lines changed

articles/automation/automation-dsc-create-composite.md

Lines changed: 42 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@ ms.service: azure-automation
1717
[!INCLUDE [aadsc-eol](~/includes/dsc-automation/aadsc-eol.md)]
1818

1919
> [!IMPORTANT]
20-
> This article refers to a solution that is maintained by the Open Source community and support is only available in the form of GitHub collaboration, not from Microsoft.
20+
> This article refers to a solution that is maintained by the Open Source community and support is
21+
> only available in the form of GitHub collaboration, not from Microsoft.
2122
22-
This article, explains on creating **scenarios** that manage groups of settings, after you get started with authoring configurations. Listed below are few examples:
23+
This article explains how to create configurations to manage the following scenarios:
2324

2425
- Create a web server
2526
- Create a DNS server
@@ -28,33 +29,56 @@ This article, explains on creating **scenarios** that manage groups of settings,
2829
- Manage firewall settings
2930
- Manage password settings
3031

31-
We recommend that you package the configuration as a [Composite Resource](/powershell/dsc/resources/authoringresourcecomposite) before you share it with others as creating composite resources for the first time can be a tedious effort.
32+
We recommend that you package the configuration as a [Composite Resource][08] before you share it
33+
with others as creating composite resources for the first time can be a tedious effort.
3234

3335
## Community project - CompositeResource
3436

35-
A [CompositeResource](https://github.com/microsoft/compositeresource) is a community maintained solution that
36-
has been created to resolve this challenge. Composite Resource automates the process of creating a new module from your configuration.
37-
37+
A [CompositeResource][11] is a community maintained solution that automates the process of creating
38+
a new module from your configuration.
3839

3940
## Create a composite resource module
4041

4142
Follow the steps to create a composite resource module:
4243

43-
1. Begin by [dot sourcing](https://devblogs.microsoft.com/scripting/how-to-reuse-windows-powershell-functions-in-scripts/) the configuration script on your workstation (or build server) to ensure that it is loaded in memory.
44-
1. Use the function provided by the *CompositeResource* module to automate a conversion instead of running the configuration to generate a *MOF* file.
45-
Here, the cmdlet will load the contents of your configuration, gets the list of parameters, and generates a new module.
46-
1. After you generate a module, you can increment the version and add release notes each time you make changes and publish it to your own
47-
[PowerShellGet repository](https://powershellexplained.com/2018-03-03-Powershell-Using-a-NuGet-server-for-a-PSRepository/?utm_source=blog&utm_medium=blog&utm_content=psscriptrepo).
48-
1. Use the module in the [Composable Authoring Experience](./compose-configurationwithcompositeresources.md) in Azure, or add them to [DSC Configuration scripts](/powershell/dsc/configurations/configurations) to generate MOF files and [upload the MOF files to Azure Automation](./tutorial-configure-servers-desired-state.md#create-and-upload-a-configuration-to-azure-automation).
49-
1. Register your servers from either [on-premises](./automation-dsc-onboarding.md#enable-physicalvirtual-linux-machines) or [in Azure](./automation-dsc-onboarding.md#enable-azure-vms)to pull configurations.
44+
1. Ensure the configuration script is loaded in your PowerShell session by [dot sourcing][10] the script.
45+
1. Rather than running the configuration to generate a **MOF** file, use the command provided by the
46+
**CompositeResource** module to automate a conversion. The command loads the contents of your
47+
configuration, gets the list of parameters, and generates a new module. After you generate a
48+
module, you can increment the version and add release notes each time you make changes and
49+
publish it to your own [PowerShellGet repository][12].
50+
1. Use the module in the [Composable Authoring Experience][03] in Azure, or add them to
51+
[DSC Configuration scripts][05] to generate MOF files and
52+
[upload the MOF files to Azure Automation][04].
53+
1. Register your servers from either [on-premises][02] or [in Azure][01]to pull configurations.
5054

5155
> [!NOTE]
52-
> The latest update to the project has also published [runbooks](https://www.powershellgallery.com/packages?q=DscGallerySamples) for Azure Automation to automate the process of importing configurations from the PowerShell Gallery.
56+
> The latest update to the project has also published [runbooks][13] for Azure Automation to
57+
> automate the process of importing configurations from the PowerShell Gallery.
5358
54-
For more information on how to automate the creation of composite resources for DSC, see [PowerShell Gallery](https://www.powershellgallery.com/packages/compositeresource/) and download the solution or select **Project Site** to view the [documentation](https://github.com/microsoft/compositeresource).
59+
For more information on how to automate the creation of composite resources for DSC, see
60+
[PowerShell Gallery][14] and download the solution or select **Project Site** to view the
61+
[documentation][11].
5562

5663
## Next steps
5764

58-
- To understand PowerShell DSC, see [Windows PowerShell Desired State Configuration overview](/powershell/dsc/overview).
59-
- Find out about PowerShell DSC resources in [DSC Resources](/powershell/dsc/resources/resources).
60-
- For details of Local Configuration Manager configuration, see [Configuring the Local Configuration Manager](/powershell/dsc/managing-nodes/metaconfig).
65+
- To understand PowerShell DSC, see [Windows PowerShell Desired State Configuration overview][07].
66+
- For more information about PowerShell DSC resources, see [DSC Resources][09].
67+
- For information about Local Configuration Manager configuration, see
68+
[Configuring the Local Configuration Manager][06].
69+
70+
<!-- link references -->
71+
[01]: ./automation-dsc-onboarding.md#enable-azure-vms
72+
[02]: ./automation-dsc-onboarding.md#enable-physicalvirtual-linux-machines
73+
[03]: ./compose-configurationwithcompositeresources.md
74+
[04]: ./tutorial-configure-servers-desired-state.md#create-and-upload-a-configuration-to-azure-automation
75+
[05]: /powershell/dsc/configurations/configurations
76+
[06]: /powershell/dsc/managing-nodes/metaconfig
77+
[07]: /powershell/dsc/overview
78+
[08]: /powershell/dsc/resources/authoringresourcecomposite
79+
[09]: /powershell/dsc/resources/resources
80+
[10]: https://devblogs.microsoft.com/scripting/how-to-reuse-windows-powershell-functions-in-scripts/
81+
[11]: https://github.com/microsoft/compositeresource
82+
[12]: https://powershellexplained.com/2018-03-03-Powershell-Using-a-NuGet-server-for-a-PSRepository/?utm_source=blog&utm_medium=blog&utm_content=psscriptrepo
83+
[13]: https://www.powershellgallery.com/packages?q=DscGallerySamples
84+
[14]: https://www.powershellgallery.com/packages/compositeresource/

0 commit comments

Comments
 (0)