Skip to content

Commit 28c91a2

Browse files
committed
Acrolinx edits
1 parent be7e44a commit 28c91a2

10 files changed

+839
-458
lines changed

articles/automation/automation-dsc-cd-chocolatey.md

Lines changed: 207 additions & 115 deletions
Large diffs are not rendered by default.

articles/automation/automation-dsc-compile.md

Lines changed: 140 additions & 60 deletions
Large diffs are not rendered by default.

articles/automation/automation-dsc-config-data-at-scale.md

Lines changed: 36 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,18 @@ ms.service: azure-automation
1717
[!INCLUDE [azure-automation-dsc-end-of-life](~/includes/dsc-automation/azure-automation-dsc-end-of-life.md)]
1818

1919
> [!IMPORTANT]
20-
> This article refers to a solution that is maintained by the Open Source community. Support is only available in the form of GitHub collaboration, and not from Microsoft.
20+
> This article refers to a solution that is maintained by the Open Source community. Support is only
21+
> available in the form of GitHub collaboration, and not from Microsoft.
2122
22-
Managing many servers is a challenge and difficulty lies in managing [configuration data](/powershell/dsc/configurations/configdata) as it involves organizing information across logical constructs like location, type, and environment.
23+
Managing many servers is a challenge and difficulty lies in managing [configuration data][04] as it
24+
involves organizing information across logical constructs like location, type, and environment.
2325

2426
## Community project: Datum
2527

26-
[Datum](https://github.com/gaelcolas/Datum) is a community maintained solution that has been created to resolve this challenge. Datum builds on great ideas from other configuration management platforms and implements the same type of solution for PowerShell DSC. Information is [organized in to text files](https://github.com/gaelcolas/Datum#3-intended-usage) based on logical ideas.
27-
28-
Listed below are few examples:
28+
[Datum][09] is a community maintained solution created to resolve this challenge. Datum builds on
29+
great ideas from other configuration management platforms and implements the same type of solution
30+
for PowerShell DSC. Information is [organized in to text files][11] based on the following logical
31+
ideas.
2932

3033
- Settings that should apply globally
3134
- Settings that should apply to all servers in a location
@@ -35,19 +38,37 @@ Listed below are few examples:
3538

3639
## Configure data at scale
3740

38-
Follow the below steps to configure data at scale for Azure Automation State Configuration:
41+
Use the following steps to configure data at scale for Azure Automation State Configuration:
3942

40-
1. The information is organized in your preferred file format. For example, *JSON*, *Yaml*, or *PSD1*.
41-
1. The cmdlets are provided to generate configuration data files by [consolidating the information](https://github.com/gaelcolas/Datum#datum-tree) from each file in to single view of a server or server role.
42-
1. After you generate the data files, you can use them with [DSC Configuration scripts](/powershell/dsc/configurations/write-compile-apply-configuration) 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).
43-
1. Register your servers from either [on-premises](./automation-dsc-onboarding.md#enable-physicalvirtual-linux-machines)
44-
or [in Azure](./automation-dsc-onboarding.md#enable-azure-vms) to pull configurations.
43+
1. Organize the information in your preferred file format. For example, *JSON*, *Yaml*, or *PSD1*.
44+
1. Use the cmdlets to generate configuration data files by [consolidating the information][12] from
45+
each file in to single view of a server or server role.
46+
1. Use the generated files with [DSC Configuration scripts][05] to generate *MOF* files and
47+
[upload the MOF files to Azure Automation][03].
48+
1. To pull configurations, register your servers from either [on-premises][02] or [in Azure][01].
4549

46-
To download the solution, go to [PowerShell Gallery](https://www.powershellgallery.com/packages/datum/) or select **Project site** to view the [documentation](https://github.com/gaelcolas/Datum#2-getting-started--concepts).
50+
To download the solution, go to [PowerShell Gallery][13] or select **Project site** to view the
51+
[documentation][10].
4752

4853

4954
## Next steps
5055

51-
- To understand PowerShell DSC, see [Windows PowerShell Desired State Configuration overview](/powershell/dsc/overview).
52-
- Find out about PowerShell DSC resources in [DSC Resources](/powershell/dsc/resources/resources).
53-
- For details of Local Configuration Manager configuration, see [Configuring the Local Configuration Manager](/powershell/dsc/managing-nodes/metaconfig).
56+
- To understand PowerShell DSC, see [Windows PowerShell Desired State Configuration overview][07].
57+
- To find PowerShell DSC resources, see [DSC Resources][08].
58+
- For details of Local Configuration Manager configuration, see
59+
[Configuring the Local Configuration Manager][06].
60+
61+
<!-- link references -->
62+
[01]: ./automation-dsc-onboarding.md#enable-azure-vms
63+
[02]: ./automation-dsc-onboarding.md#enable-physicalvirtual-linux-machines
64+
[03]: ./tutorial-configure-servers-desired-state.md#create-and-upload-a-configuration-to-azure-automation
65+
[04]: /powershell/dsc/configurations/configdata
66+
[05]: /powershell/dsc/configurations/write-compile-apply-configuration
67+
[06]: /powershell/dsc/managing-nodes/metaconfig
68+
[07]: /powershell/dsc/overview
69+
[08]: /powershell/dsc/resources/resources
70+
[09]: https://github.com/gaelcolas/Datum
71+
[10]: https://github.com/gaelcolas/Datum#2-getting-started--concepts
72+
[11]: https://github.com/gaelcolas/Datum#3-intended-usage
73+
[12]: https://github.com/gaelcolas/Datum#datum-tree
74+
[13]: https://www.powershellgallery.com/packages/datum/

articles/automation/automation-dsc-configuration-based-on-stig.md

Lines changed: 33 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -15,50 +15,47 @@ ms.service: azure-automation
1515
1616
[!INCLUDE [azure-automation-dsc-end-of-life](~/includes/dsc-automation/azure-automation-dsc-end-of-life.md)]
1717

18-
Creating configuration content for the first time can be challenging.
19-
In many cases, the goal is to automate configuration of servers following a "baseline" that hopefully aligns to an industry recommendation.
18+
Creating configuration content for the first time can be challenging. In many cases, the goal is to
19+
automate configuration of servers following a "baseline" that hopefully aligns to an industry
20+
recommendation.
2021

2122
> [!NOTE]
22-
> This article refers to a solution that is maintained by the Open Source community.
23-
> Support is only available in the form of GitHub collaboration, not from Microsoft.
23+
> This article refers to a solution that's maintained by the Open Source community. Support is only
24+
> available in the form of GitHub collaboration, not from Microsoft.
2425
2526
## Community project: PowerSTIG
2627

27-
A community project named
28-
[PowerSTIG](https://github.com/microsoft/powerstig)
29-
aims to resolve this issue by generating DSC content based on
30-
[public information](https://public.cyber.mil/stigs/)
31-
provided about STIG (Security Technical Implementation Guide),
28+
A community project named [PowerSTIG][08] aims to resolve this issue by generating DSC content based
29+
on [public information][11] provided about STIG (Security Technical Implementation Guide),
3230

33-
Dealing with baselines is more complicated than it sounds.
34-
Many organizations need to
35-
[document exceptions](https://github.com/microsoft/powerstig#powerstigdata)
36-
to rules and manage that data at scale.
37-
PowerSTIG addresses the problem by providing
38-
[Composite Resources](https://github.com/microsoft/powerstig#powerstigdsc)
39-
to address each area of the configuration
40-
rather than trying to address the entire range of settings
41-
in one large file.
31+
Dealing with baselines is more complicated than it sounds. Many organizations need to
32+
[document exceptions][09] to rules and manage that data at scale. PowerSTIG addresses the problem by
33+
providing [Composite Resources][10] to address each area of the configuration rather than trying to
34+
address the entire range of settings in one large file.
4235

43-
Once the configurations have been generated,
44-
you can use the
45-
[DSC Configuration scripts](/powershell/dsc/configurations/configurations)
46-
to generate MOF files
47-
and
48-
[upload the MOF files to Azure Automation](./tutorial-configure-servers-desired-state.md#create-and-upload-a-configuration-to-azure-automation).
49-
Then register your servers from either
50-
[on-premises](./automation-dsc-onboarding.md#enable-physicalvirtual-linux-machines)
51-
or [in Azure](./automation-dsc-onboarding.md#enable-azure-vms)
52-
to pull configurations.
36+
After you create the configurations, you can use the [DSC Configuration scripts][04] to generate MOF
37+
files and [upload the MOF files to Azure Automation][03]. To pull configurations, register your
38+
servers from either [on-premises][02] or [in Azure][01].
5339

54-
To try out PowerSTIG, visit the
55-
[PowerShell Gallery](https://www.powershellgallery.com)
56-
and download the solution or click "Project Site"
57-
to view the
58-
[documentation](https://github.com/microsoft/powerstig).
40+
To try out PowerSTIG, visit the [PowerShell Gallery][12] and download the solution or select
41+
**Project Site** to view the [documentation][08].
5942

6043
## Next steps
6144

62-
- To understand PowerShell DSC, see [Windows PowerShell Desired State Configuration overview](/powershell/dsc/overview).
63-
- Find out about PowerShell DSC resources in [DSC Resources](/powershell/dsc/resources/resources).
64-
- For details of Local Configuration Manager configuration, see [Configuring the Local Configuration Manager](/powershell/dsc/managing-nodes/metaconfig).
45+
- To understand PowerShell DSC, see [Windows PowerShell Desired State Configuration overview][06].
46+
- To find PowerShell DSC resources, see [DSC Resources][07].
47+
- For details of Local Configuration Manager configuration, see [Configuring the Local Configuration Manager][05].
48+
49+
<!-- link references -->
50+
[01]: ./automation-dsc-onboarding.md#enable-azure-vms
51+
[02]: ./automation-dsc-onboarding.md#enable-physicalvirtual-linux-machines
52+
[03]: ./tutorial-configure-servers-desired-state.md#create-and-upload-a-configuration-to-azure-automation
53+
[04]: /powershell/dsc/configurations/configurations
54+
[05]: /powershell/dsc/managing-nodes/metaconfig
55+
[06]: /powershell/dsc/overview
56+
[07]: /powershell/dsc/resources/resources
57+
[08]: https://github.com/microsoft/powerstig
58+
[09]: https://github.com/microsoft/powerstig#powerstigdata
59+
[10]: https://github.com/microsoft/powerstig#powerstigdsc
60+
[11]: https://public.cyber.mil/stigs/
61+
[12]: https://www.powershellgallery.com

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ a new module from your configuration.
4141

4242
Follow the steps to create a composite resource module:
4343

44-
1. Ensure the configuration script is loaded in your PowerShell session by [dot sourcing][10] the script.
44+
1. Ensure the configuration script is loaded in your PowerShell session by [dot sourcing][10] the
45+
script.
4546
1. Rather than running the configuration to generate a **MOF** file, use the command provided by the
4647
**CompositeResource** module to automate a conversion. The command loads the contents of your
4748
configuration, gets the list of parameters, and generates a new module. After you generate a

0 commit comments

Comments
 (0)