Skip to content

Commit 96e3d44

Browse files
authored
Merge pull request #15 from xoap-io/dev
fix: multiple adjustments to README.md
2 parents 685b33a + 6ff0322 commit 96e3d44

File tree

1 file changed

+30
-15
lines changed

1 file changed

+30
-15
lines changed

README.md

+30-15
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@
1717

1818
## Introduction
1919

20-
This is the XOAP PowerShell DSC configuration repository.
20+
This is the [XOAP](https://xoap.io) PowerShell DSC configuration repository.
2121

22-
It is part of our XOAP Automation Forces Open Source community library to give you a quick start into Infrastructure as Code deployments with PowerShell DSC in addition to config.XO.
22+
It is part of our [XOAP](https://xoap.io) Automation Forces Open Source community library to give you a quick start into Infrastructure as Code deployments with PowerShell DSC in addition to config.XO.
2323

2424
Please check the links for more info, including usage information and full documentation:
2525

@@ -32,42 +32,53 @@ Please check the links for more info, including usage information and full docum
3232

3333
## Disclaimer
3434

35-
**All configurations are provided AS IS. We are not responsible for anything that happens inside your environment because you applied the configurations and didn´t test them thoroughly before doing so.**
35+
**All configurations are provided AS IS. We are not responsible for anything that happens inside your environment because you applied the configurations and did not test them thoroughly before doing so.**
3636

3737
Be sure to always test any of those configurations in separated test environment and test clients and servers.
3838

39-
>Some of the available DSC configurations make severe changes to security related configurations and could leave your Windows operating system in an unusable state.
39+
>Some of the available DSC configurations make severe changes to security-related configurations and could leave your Windows operating system in an unusable state.
4040
4141
So please test once, twice or trice.
4242

4343
---
4444

4545
## Guidelines
4646

47-
We are using the following guidelines to write code and make it easier for everyone to follow a distinctive guideline. Please check these links before starting to work on changes.
47+
We are using the following guidelines to write code and make it easier for everyone to follow a distinctive guideline.
48+
Please check these links before starting to work on changes.
4849

4950
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
5051

51-
Git Naming Conventions are an important part of the development process. They describe how Branches, Commit Messages, Pull Requests and Tags should look like to make the easily understandable for everybody in the development chain.
52+
Git Naming Conventions are an important part of the development process.
53+
They describe how Branches, Commit Messages,
54+
Pull Requests and Tags should look like to make them easily understandable for everybody in the development chain.
5255

5356
[Git Naming Conventions](https://namingconvention.org/git/)
5457

55-
The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of.
58+
He Conventional Commits specification is a lightweight convention on top of commit messages.
59+
It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of.
5660

5761
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
5862

59-
The better a Pull Request description is, the better a review can understand and decide on how to review the changes. This improves implementation speed and reduces communication between the requester and the reviewer resulting in much less overhead.
63+
The better a Pull Request description is, the better a review can understand and decide on how to review the changes.
64+
This improves implementation speed and reduces communication between the requester,
65+
and the reviewer is resulting in much less overhead.
6066

6167
[Writing A Great Pull Request Description](https://www.pullrequest.com/blog/writing-a-great-pull-request-description/)
6268

63-
Versioning is a crucial part for everything as code. Without version tags you cannot clearly create a stable environment and be sure that your latest changes won't crash your production environment (sure it still can happen, but we are trying our best to implement everything that we can to reduce the risk)
69+
Versioning is a crucial part for Terraform Stacks and Modules.
70+
Without version tags you cannot clearly create a stable environment
71+
and be sure that your latest changes will not crash your production environment (sure it still can happen,
72+
but we are trying our best to implement everything that we can to reduce the risk)
6473

6574
[Semantic Versioning](https://semver.org)
6675

6776
---
6877

6978
## Share the Love
70-
Like this project? Please give it a ★ on [our GitHub](https://github.com/xoap-io/xoap-uberagent-kibana-dashboards)! (it helps us a lot).
79+
Like this project?
80+
Please give it a ★ on [our GitHub](https://github.com/xoap-io/xoap-powershell-dsc-configurations)!
81+
It helps us a lot.
7182

7283
---
7384

@@ -97,7 +108,8 @@ PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
97108

98109
### Local usage
99110

100-
On most supported Windows versions you don´t have to do anything. On windows versions prior to Windows Server 2016 or Windows 10 you should install Windows Management Framework 5.1.
111+
On most supported Windows versions, you do not have to do anything.
112+
On windows versions prior to Windows Server 2016 or Windows 10, you should install Windows Management Framework 5.1.
101113
You can download it [here](https://www.microsoft.com/en-us/download/details.aspx?id=54616).
102114

103115
#### Compile and Apply
@@ -126,7 +138,7 @@ Configuration MSTF_SecurityBaseline_Edge_v107_Computer
126138
}
127139
```
128140

129-
In order to compile this example you need to take care that all the referenced DSC modules are available locally.
141+
In order to compile this example, you need to take care that all the referenced DSC modules are available locally.
130142

131143
You can check availability with:
132144

@@ -140,9 +152,11 @@ If DSC modules are missing, you can install them simply by e.g. running:
140152
Install-Module SecurityPolicyDSC
141153
```
142154

143-
It could be that you need to install PowerShellGet and the NuGet provider and that you have to trust the PSGallery to be able to install the DSC modules.
155+
It could be that you need to install PowerShellGet and the NuGet provider,
156+
and that you have to trust the PSGallery to be able to install the DSC modules.
144157

145-
> Please be aware that this is the most basic example. We advise to always define the module versions in production environments before compiling them and to implement a versioning system to track changes to those DSC configurations. Not defining versions could lead to compiling errors because of functional changes between vmodule versions.
158+
> Please be aware that this is the most basic example. We advise to always define the module versions in production environments before compiling them and to implement a versioning system to track changes to those DSC configurations.
159+
> Not defining versions could lead to compiling errors because of functional changes between module versions.
146160
147161
Defining the versions of the modules could look like this:
148162

@@ -168,7 +182,8 @@ Configuration MSTF_SecurityBaseline_Edge_v107_Computer
168182
}
169183
```
170184

171-
So now that all DSC modules are available and the module versions are defined you need to run the following command in your Powershell to compile it locally:
185+
So now that all DSC modules are available and the module versions are defined,
186+
you need to run the following command in your Powershell to compile it locally:
172187

173188
```
174189
. PATHTOYOURSCRIPT\MSTF_SecurityBaseline_Edge_v107_Computer.ps1

0 commit comments

Comments
 (0)