Skip to content

Commit

Permalink
Merge pull request #15 from xoap-io/dev
Browse files Browse the repository at this point in the history
fix: multiple adjustments to README.md
  • Loading branch information
ssokolic authored Apr 25, 2023
2 parents 685b33a + 6ff0322 commit 96e3d44
Showing 1 changed file with 30 additions and 15 deletions.
45 changes: 30 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@

## Introduction

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

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.
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.

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

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

## Disclaimer

**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.**
**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.**

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

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

---

## Guidelines

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.
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.

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

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.
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 them easily understandable for everybody in the development chain.

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

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.
He 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.

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

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.
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 is resulting in much less overhead.

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

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)
Versioning is a crucial part for Terraform Stacks and Modules.
Without version tags you cannot clearly create a stable environment
and be sure that your latest changes will not 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)

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

---

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

---

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

### Local usage

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.
On most supported Windows versions, you do not have to do anything.
On windows versions prior to Windows Server 2016 or Windows 10, you should install Windows Management Framework 5.1.
You can download it [here](https://www.microsoft.com/en-us/download/details.aspx?id=54616).

#### Compile and Apply
Expand Down Expand Up @@ -126,7 +138,7 @@ Configuration MSTF_SecurityBaseline_Edge_v107_Computer
}
```

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

You can check availability with:

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

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.
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.

> 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.
> 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 module versions.
Defining the versions of the modules could look like this:

Expand All @@ -168,7 +182,8 @@ Configuration MSTF_SecurityBaseline_Edge_v107_Computer
}
```

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:
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:

```
. PATHTOYOURSCRIPT\MSTF_SecurityBaseline_Edge_v107_Computer.ps1
Expand Down

0 comments on commit 96e3d44

Please sign in to comment.