Skip to content

Commit 9958329

Browse files
committed
Update documentation
1 parent f39c26b commit 9958329

11 files changed

+8
-98
lines changed

doc/02-Installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Installing the module is managed by different ways, depending on the user enviro
66
Instructions
77
---
88

9-
* Install the Module with the [Kickstart Script](installation/01-KickstartScript.md)
10-
* Install the Module [manually](installation/02-ManualInstallation.md)
9+
* Install the Module with the [Kickstart Script](installation/01-Kickstart-Script.md)
10+
* Install the Module [manually](installation/02-Manual-Installation.md)
1111

1212
Testing the installation
1313
---

doc/03-WebIntegration.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

doc/04-DeveloperGuide.md renamed to doc/04-Developer-Guide.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ Functions
1010

1111
A detailed overview of functions can be found below
1212

13-
* [New-IcingaCheck](developerguide/01-NewIcingaCheck.md)
13+
* [New-IcingaCheck](developerguide/01-New-IcingaCheck.md)
14+
* [New-IcingaCheckPackage](developerguide/02-New-IcingaCheckPackage.md)

doc/05-IcingaIntegration.md renamed to doc/05-Icinga-Integration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ Configuring Check-Commands
1616

1717
To get started, there are two ways to configure check command objects:
1818

19-
* [Automated configuration](icingaintegration/01-DirectorBaskets.md) with Baskets
20-
* [Manual configuration](icingaintegration/02-Icinga2AgentExample.md) of check commands
19+
* [Automated configuration](icingaintegration/01-Director-Baskets.md) with Baskets
20+
* [Manual configuration](icingaintegration/02-Manual-Integration.md) of check commands

doc/10-InstallService.md renamed to doc/10-Install-Service.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,9 @@ icinga-service.exe
3030
Now lets install the service with the help of the PowerShell Module:
3131

3232
```powershell
33-
Install-IcingaFrameworkService -ServicePath 'C:\Program Files\Icinga-Framework-Service\icinga-service.exe'
33+
Install-IcingaFrameworkService -Path 'C:\Program Files\Icinga-Framework-Service\icinga-service.exe'
3434
```
3535

3636
You can validate if the service has been installed properly by using the Get Service Cmdlet:
3737

38-
```powershell
39-
Get-IcingaFrameworkService
40-
```
41-
42-
Of course there are more Cmdlets available, making the management of this Icinga Service alot easier, which should be self explaining:
43-
44-
* Start-IcingaFrameworkService
45-
* Stop-IcingaFrameworkService
46-
* Restart-IcingaFrameworkService
47-
* Uninstall-IcingaFrameworkService
48-
4938
Each enabled background daemon component is afterwards being started and executed.

doc/11-IcingaWeb2Integration.md

Lines changed: 0 additions & 40 deletions
This file was deleted.
File renamed without changes.

doc/icingaintegration/01-DirectorBaskets.md renamed to doc/icingaintegration/01-Director-Baskets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ If you wish to specify specific commands only, you can filter them as well:
2828
Get-IcingaCheckCommandConfig -CheckName Invoke-IcingaCheckBiosSerial, Invoke-IcingaCheckCPU
2929
```
3030

31-
Last but not least you can output the JSON-Basket directly into a file. To do this, simply use the `OutFile` argument. You only require to specify a directory here, as the file including a timestamp is generated by the Cmdlet itself
31+
Last but not least you can output the JSON-Basket directly into a file. To do this, simply use the `OutDirectory` argument. You only require to specify a directory here, as the file including a timestamp is generated by the Cmdlet itself
3232

3333
```powershell
3434
Get-IcingaCheckCommandConfig -OutDirectory 'C:\Users\myuser\Documents\
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)