Skip to content

Commit ff96362

Browse files
committed
Update docs
Split docs on configurations into `configs.md`
1 parent a8b9a86 commit ff96362

File tree

3 files changed

+36
-32
lines changed

3 files changed

+36
-32
lines changed

docs/configs.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Configurations
3+
summary:
4+
authors:
5+
- Aaron Parker
6+
---
7+
Configurations are implemented with `Install-Defaults.ps1`. This script reads configurations in JSON format and configures the local Windows instance with Windows feature states, registry settings, copies files into specified paths, imports a default Start menu, and modifies the default user profile.
8+
9+
Configurations are stored in the following JSON files with the logic to make changes to Windows includes in `Install-Defaults.ps1`:
10+
11+
* [Build.All.json](https://github.com/aaronparker/image-customise/blob/main/src/Build.All.json)
12+
* [Machine.All.json](https://github.com/aaronparker/image-customise/blob/main/src/Machine.All.json)
13+
* [Machine.Client.json](https://github.com/aaronparker/image-customise/blob/main/src/Machine.Client.json)
14+
* [Machine.Server.json](https://github.com/aaronparker/image-customise/blob/main/src/Machine.Server.json)
15+
* [User.All.json](https://github.com/aaronparker/image-customise/blob/main/src/User.All.json)
16+
* [User.Client.json](https://github.com/aaronparker/image-customise/blob/main/src/User.Client.json)
17+
* [User.Server.json](https://github.com/aaronparker/image-customise/blob/main/src/User.Machine.json)
18+
* [User.Virtual.json](https://github.com/aaronparker/image-customise/blob/main/src/User.Virtual.json)
19+
20+
JSON files are gathered based on properties of the local Windows instance. The following keywords, used in the file names, ensure that the right JSON files are selected:
21+
22+
* `Client` - Windows 10 or Windows 11
23+
* `Server` - Windows Server 2016, 2019, 2022
24+
* `Virtual` - Virtual machines, e.g. Hyper-V, Azure, vSphere, Parallels etc.
25+
* `All` - applies to all Windows instances
26+
27+
Each JSON file includes a `MininumBuild` property that can be used to ensure specific configurations only apply to a specific version of Windows or above. For example, the property might ensure that configurations only apply to Windows 10 version `10.0.19041` and above.

docs/install.md

Lines changed: 5 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,6 @@ summary:
44
authors:
55
- Aaron Parker
66
---
7-
## Download and Deploy
8-
9-
To use the scripts in an operating system deployment pipeline, download the zip file attached to the [latest release](https://github.com/aaronparker/image-customise/releases) and import the extracted files into your OS deployment solution (e.g. MDT, ConfigMgr, Packer etc.).
10-
11-
### Microsoft Intune
12-
13-
The solution is also provided in `.intunewin` format for use with Microsoft Intune. Settings for a Win32 package in Intune is maintained here: [App.json](https://github.com/aaronparker/image-customise/blob/main/App.json).
14-
15-
![Windows Custom Defaults as a Win32 application in Microsoft Intune](assets/img/intuneapp01.png)
16-
177
## Download and Install
188

199
To simplify download and install during an automated image build pipeline, an install script is provided that can be executed with the following PowerShell:
@@ -24,26 +14,12 @@ Set-ExecutionPolicy Bypass -Scope Process -Force;
2414
Invoke-Expression ((New-Object System.Net.WebClient).DownloadString("https://raw.githubusercontent.com/aaronparker/image-customise/main/install.ps1"))
2515
```
2616

27-
## Configuration Files
28-
29-
Configurations are implemented with `Install-Defaults.ps1`. This script reads configurations in JSON format and configures the local Windows instance with Windows feature states, registry settings, copies files into specified paths, imports a default Start menu, and modifies the default user profile.
30-
31-
Configurations are stored in the following JSON files with the logic to make changes to Windows includes in `Install-Defaults.ps1`:
17+
## Download and Deploy
3218

33-
* [Build.All.json](https://github.com/aaronparker/image-customise/blob/main/src/Build.All.json)
34-
* [Machine.All.json](https://github.com/aaronparker/image-customise/blob/main/src/Machine.All.json)
35-
* [Machine.Client.json](https://github.com/aaronparker/image-customise/blob/main/src/Machine.Client.json)
36-
* [Machine.Server.json](https://github.com/aaronparker/image-customise/blob/main/src/Machine.Server.json)
37-
* [User.All.json](https://github.com/aaronparker/image-customise/blob/main/src/User.All.json)
38-
* [User.Client.json](https://github.com/aaronparker/image-customise/blob/main/src/User.Client.json)
39-
* [User.Server.json](https://github.com/aaronparker/image-customise/blob/main/src/User.Machine.json)
40-
* [User.Virtual.json](https://github.com/aaronparker/image-customise/blob/main/src/User.Virtual.json)
19+
To use the scripts in an operating system deployment pipeline, download the zip file attached to the [latest release](https://github.com/aaronparker/image-customise/releases) and import the extracted files into your OS deployment solution (e.g. MDT, ConfigMgr, Packer etc.).
4120

42-
JSON files are gathered based on properties of the local Windows instance. The following keywords, used in the file names, ensure that the right JSON files are selected:
21+
### Microsoft Intune
4322

44-
* `Client` - Windows 10 or Windows 11
45-
* `Server` - Windows Server 2016, 2019, 2022
46-
* `Virtual` - Virtual machines, e.g. Hyper-V, Azure, vSphere, Parallels etc.
47-
* `All` - applies to all Windows instances
23+
The solution is also provided in `.intunewin` format for use with Microsoft Intune. Settings for a Win32 package in Intune is maintained here: [App.json](https://github.com/aaronparker/image-customise/blob/main/App.json).
4824

49-
Each JSON file includes a `MininumBuild` property that can be used to ensure specific configurations only apply to a specific version of Windows or above. For example, the property might ensure that configurations only apply to Windows 10 version `10.0.19041` and above.
25+
![Windows Custom Defaults as a Win32 application in Microsoft Intune](assets/img/intuneapp01.png)

mkdocs.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,9 @@ extra:
115115

116116
nav:
117117
- Introduction: index.md
118-
- Install Defaults: install.md
119-
- Scripts:
118+
- Install defaults: install.md
119+
- Under the hood:
120+
- Configurations: configs.md
120121
- Remove UWP apps: appxapps.md
121122
- Machine settings: machine.md
122-
- Default Profile customisations: profile.md
123+
- User settings: profile.md

0 commit comments

Comments
 (0)