Skip to content

Commit 36e6462

Browse files
authored
Merge pull request #470 from Icinga:doc/updates_docs_broken_links
Doc: Updates broken links and spelling errors
2 parents 901c34a + c6ea622 commit 36e6462

File tree

3 files changed

+29
-11
lines changed

3 files changed

+29
-11
lines changed

doc/100-General/20-Eventlog.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,6 @@
22

33
Below you will find a list of EventId's which are exported by this module. The short and detailed message are both written directly into the EventLog. This documentation shall simply provide a summary of available EventId's
44

5-
## Event Id 1000
6-
7-
| Category | Short Message | Detailed Message |
8-
| --- | --- | --- |
9-
| Information | Generic debug message issued by the Framework or its components | The Framework or is components can issue generic debug message in case the debug log is enabled. Please ensure to disable it, if not used. You can do so with the command "Disable-IcingaFrameworkDebugMode" |
10-
115
## Event Id 1001
126

137
| Category | Short Message | Detailed Message |
@@ -44,6 +38,30 @@ Below you will find a list of EventId's which are exported by this module. The s
4438
| --- | --- | --- |
4539
| Error | Icinga for Windows background daemon not found | Icinga for Windows could not find the Function or Cmdlet for the specified background daemon. The daemon was not loaded. |
4640

41+
## Event Id 1401
42+
43+
| Category | Short Message | Detailed Message |
44+
| --- | --- | --- |
45+
| Error | Icinga for Windows thread pool not found | Icinga for Windows was unable to find a specified thread pool with [Get-IcingaThreadPool] for a background daemon. To keep the daemon running, it defaulted to a basic pool but this issue should be addressed. The name of the inquired pool is: |
46+
47+
## Event Id 1450
48+
49+
| Category | Short Message | Detailed Message |
50+
| --- | --- | --- |
51+
| Error | Icinga for Windows service check daemon invalid index | Icinga for Windows is unable to process the provided time index for a background service check task, as a given index is not numeric |
52+
53+
## Event Id 1451
54+
55+
| Category | Short Message | Detailed Message |
56+
| --- | --- | --- |
57+
| Error | Icinga for Windows service check daemon exception on plugin execution | Icinga for Windows failed to execute a plugin within the background service check daemon with an exception |
58+
59+
## Event Id 1452
60+
61+
| Category | Short Message | Detailed Message |
62+
| --- | --- | --- |
63+
| Error | Icinga for Windows service check daemon failed with exception | Icinga for Windows failed to properly execute a task within the background service check daemon with a given exception |
64+
4765
## Event Id 1500
4866

4967
| Category | Short Message | Detailed Message |
@@ -78,7 +96,7 @@ Below you will find a list of EventId's which are exported by this module. The s
7896

7997
| Category | Short Message | Detailed Message |
8098
| --- | --- | --- |
81-
| Warning | Icinga for Windows JEA context not available | The Icinga for Windows JEA session is no longer available and is attempted to be restarted on the system. This could have either happened due to a crash or a user action, like restarting the WinRM service. |
99+
| Warning | Icinga for Windows JEA context not available | The Icinga for Windows JEA session is no longer available and is attempted to be restarted on the system. This could have either happenend due to a crash or a user action, like restarting the WinRM service. |
82100

83101
## Event Id 1550
84102

@@ -90,7 +108,7 @@ Below you will find a list of EventId's which are exported by this module. The s
90108

91109
| Category | Short Message | Detailed Message |
92110
| --- | --- | --- |
93-
| Warning | Invalid authentication credentials provided | A web request for a client was rejected because of invalid formatted base64 encoded credentials. |
111+
| Warning | Invalid authentication credentials provided | A web request for a client was rejected because of invalid formated base64 encoded credentials. |
94112

95113
## Event Id 1552
96114

doc/900-Developer-Guide/00-General.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ $Global:Icinga.Public.Threads.'Start-IcingaForWindowsDaemon::Add-IcingaForWindow
110110

111111
This is a section reserved for Icinga for Windows and Icinga developers in general. This space will store general information for Icinga for Windows, determining on how the PowerShell instance is handling internal requests and procedures.
112112

113-
As custom module developer, you can **read** from this space but are in genetal **not** allowed to store information there. Please use the `Private` and `Public` space for this.
113+
As custom module developer, you can **read** from this space but are in general **not** allowed to store information there. Please use the `Private` and `Public` space for this.
114114

115115
The following entries are set by default within the `Protected` space:
116116

@@ -141,7 +141,7 @@ The command ships with a bunch of configurations to modify the created `.psd1` i
141141

142142
Once you have started to write your own code, you can use the Cmdlet `Publish-IcingaForWindowsComponent` to update the `NestedModules` attribute inside the `.psd1` file automatically, including the documentation in case the module is of type plugin.
143143

144-
In addition, you ca create a `.zip` file for this module which can be integrated directly into the [Repository Manager](..\120-Repository-Manager\01-Add-Repositories.md). By default, created `.zip` files will be created in your home folder, the path can how ever be changed while executing the command.
144+
In addition, you ca create a `.zip` file for this module which can be integrated directly into the [Repository Manager](../120-Repository-Manager/01-Add-Repositories.md). By default, created `.zip` files will be created in your home folder, the path can how ever be changed while executing the command.
145145

146146
| Argument | Type | Description |
147147
| --- | --- | --- |

doc/900-Developer-Guide/21-Using-EventLog-Outputs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,4 +123,4 @@ A huge benefit of the implementation we choose is the possibility to export the
123123
Publish-IcingaEventLogDocumentation -Namespace 'Framework' -OutFile 'C:\users\public\EventLog-doc.md':
124124
```
125125

126-
An example on how the exported result looks like can be found on the [Framework EventLog Documentation](../100-General/20-EventLog.md).
126+
An example on how the exported result looks like can be found on the [Framework EventLog Documentation](../100-General/20-Eventlog.md).

0 commit comments

Comments
 (0)