Skip to content

Commit d0ab174

Browse files
committedDec 24, 2016
Fixed a lot of markdown syntax issues
1 parent 35d47a2 commit d0ab174

19 files changed

+556
-566
lines changed
 

‎docs/about/bugs.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Reporting Bugs #
1+
# Reporting Bugs
22

33
NSClient++ is a mature monitoring agent which has established a reputation for stability.
44
In order to maintain this reputation, the developers would like to know of any deficiencies you find in NSClient++.
55

6-
## Documentation bugs ##
6+
## Documentation bugs
77

88
If you find a bug in this documentation or would like to propose an improvement,
99
please send an e-mail to docs@nsclient.org describing the bug and where you found
@@ -15,9 +15,9 @@ noticed, even if it takes a while to be processed.
1515
Of course, if you want a more persistent record of your issue, you can use the
1616
issue tracker for documentation bugs as well.
1717

18-
## Using the NSClient++ issue tracker ##
18+
## Using the NSClient++ issue tracker
1919

20-
Bug reports for NSClient++ itself should be submitted via the NSClient++ Bug Tracker on github (https://github.com/mickem/nscp/issues).
20+
Bug reports for NSClient++ itself should be submitted via the NSClient++ Bug Tracker on github [here](https://github.com/mickem/nscp/issues).
2121
The bug tracker offers a Web form
2222
which allows pertinent information to be entered and submitted to the developers.
2323

@@ -47,5 +47,5 @@ Each bug report will be assigned to a developer who will determine what needs to
4747
be done to correct the problem. You will receive an update each time action is
4848
taken on the bug.
4949

50-
* [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html)
51-
* [Bug Writing Guidelines](http://developer.mozilla.org/en/docs/Bug_writing_guidelines)
50+
* [How to Report Bugs Effectively](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html)
51+
* [Bug Writing Guidelines](http://developer.mozilla.org/en/docs/Bug_writing_guidelines)

‎docs/about/build.md

+12-13
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# Building NSClient++ #
1+
# Building NSClient++
22

3-
NSclient++ is fairly simple to build and setup. It requires python and cmake for the build process as well as a number of external libraries.
3+
NSClient++ is fairly simple to build and setup. It requires python and cmake for the build process as well as a number of external libraries.
44
This document is split between "Linux" and "Windows" since there is a substantial difference in how to build them.
5-
For people wanting a Apple osx version it can be built similrily to the Linux machines on that platform as well.
5+
For people wanting a Apple osx version it can be built similarly to the Linux machines on that platform as well.
66

7-
## Linux ##
7+
## Linux
88

99
The dependencies are different on different Linux systems so we will start with a section on installing dependencies on various platforms.
1010

11-
### Dependencies on Ubuntu ###
11+
### Dependencies on Ubuntu
1212

1313
First we need to install a set of packages:
1414

@@ -26,11 +26,11 @@ sudo apt-get install -y liblua5.1-0-dev
2626
sudo apt-get install -y libgtest-dev
2727
```
2828

29-
### Getting the code from github ###
29+
### Getting the code from github
3030

3131
Next up we download the source code from github: `git clone --recursive https://github.com/mickem/nscp.git`
3232

33-
### Building NSClient++ ###
33+
### Building NSClient++
3434

3535
Create a folder in which we will build the code:
3636
```
@@ -55,7 +55,7 @@ make test
5555
5656
## Windows ##
5757
58-
Dependencies is a bit of a bother to manage on Windows since there is no general package mechanism for libraries.
58+
Dependencies is a bit of a bother to manage on Windows since there is no general package mechanism for libraries.
5959
To help with the there is a script called fetch-deps.py which will help download and build all dependencies required.
6060
6161
### Tools ###
@@ -103,12 +103,12 @@ cmake -D TARGET=dist -D SOURCE=nscp -P nscp\check_deps.cmake
103103
Build NSClient++ (If you don't know you your visual studio version name you can run cmake --help to list all available profiles):
104104

105105
```
106-
<p>cd dist</p>
107-
<p>cmake -G "VISUAL STUDIO GNERATOR STRING" ../nscp</p>
108-
<p>msbuild /p:Configuration=RelWithDebInfo NSCP.sln</p>
106+
cd dist
107+
cmake -G "VISUAL STUDIO GNERATOR STRING" ../nscp
108+
msbuild /p:Configuration=RelWithDebInfo NSCP.sln
109109
```
110110

111-
## Vagrant ##
111+
## Vagrant
112112

113113
We provide a number of vagrant profiles which will built NSClient++ as well:
114114

@@ -123,4 +123,3 @@ vagrant up -- provision
123123
```
124124

125125
The resultiung packages will be found under packages
126-

‎docs/about/index.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# About these documents #
1+
# About these documents
22

33
These documents are generated from `markdown` sources by `mkdocs`, a document processor written in Python.
44

5-
* [markdown](http://daringfireball.net/projects/markdown/syntax)
6-
* [mkdocs](http://www.mkdocs.org/)
7-
* [NSClient++ documentation sources](https://github.com/mickem/nscp-docs)
5+
* [markdown](http://daringfireball.net/projects/markdown/syntax)
6+
* [mkdocs](http://www.mkdocs.org/)
7+
* [NSClient++ documentation sources](https://github.com/mickem/nscp-docs)
88

9-
## Contributing to the NSClient++ Documentation ##
9+
## Contributing to the NSClient++ Documentation
1010

1111
Is easy you can find the documentation hosted on github: [here](https://github.com/mickem/nscp-docs)
1212

13-
## Contributors to the NSClient++ Documentation ##
13+
## Contributors to the NSClient++ Documentation
1414

1515
Many people have contributed to the NSClient++ project, and the NSClient++ documentation.
1616

‎docs/about/whatsnew/0.4.0.md

+32-33
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ So finally after a years of vapor ware we finally have what I consider to be the
44

55
## Versions ##
66

7-
Well the first noticeable change is that there is now build number in the version as well as versions. So you will not be downloading 0.4.0 you will be downloading 0.4.0.'''172'''. Meaning this is the 172:th build with more to come. The builds to follow will be bug fixes. I am already working on a 0.4.1 (which will in the near future add support for NRDP, check_mk and NSCP) this version will be a "compatible version" which is aimed at "bigger bug-fixes" and additions.
7+
Well the first noticeable change is that there is now build number in the version as well as versions. So you will not be downloading 0.4.0 you will be downloading 0.4.0.'''172'''. Meaning this is the 172:th build with more to come. The builds to follow will be bug fixes. I am already working on a 0.4.1 (which will in the near future add support for NRDP, `check_mk` and NSCP) this version will be a "compatible version" which is aimed at "bigger bug-fixes" and additions.
88
After this we will have 0.4.2 which will be the "next" version.
99

10-
## Whats new ##
10+
## What's new ##
1111

1212
The main new feature of 0.4.0 is the "core" which has been replaced with a new modern one built on top of various standard libraries.
1313
In addition to this we also have a new command line syntax and a new improved setting subsystem.
@@ -19,55 +19,54 @@ I would say this is the biggest update of NSClient++ ever.
1919

2020
Many new protocols supported:
2121

22-
- NRPE
23-
- NSCA
24-
- NSClient "check_nt"
25-
- SysLog?
26-
- SMTP
27-
- Graphite
28-
- NSCP (early concept version, both as distributed (think gearman) and non distributed (think NSCA/NRPE))
22+
- NRPE
23+
- NSCA
24+
- NSClient "check_nt"
25+
- SysLog?
26+
- SMTP
27+
- Graphite
28+
- NSCP (early concept version, both as distributed (think gearman) and non distributed (think NSCA/NRPE))
2929

3030
I am planning:
3131

32-
- http (rest)
33-
- check_mk
34-
- NRDP
35-
- SNMP
36-
- WMI ("native remote windows checks")
32+
- http (rest)
33+
- check_mk
34+
- NRDP
35+
- SNMP
3736

3837
## Scripting ##
3938

4039
There is a brand new plugin/script API which has been extended to allow extensions in:
4140

42-
- Python
43-
- Lua
44-
- .Net
45-
- plugins (C/C++/\*)
41+
- Python
42+
- Lua
43+
- .Net
44+
- plugins (C/C++/\*)
4645

4746
## Settings ##
4847

4948
Brand new flexible settings sub systems which supports many new formats as well as generation and inclusion between formats.
5049

51-
- ini-files
52-
- registry
53-
- http (ini files)
54-
- old
55-
- dummy (in memory store)
50+
- ini-files
51+
- registry
52+
- http (ini files)
53+
- old
54+
- dummy (in memory store)
5655

5756
Currently planned:
5857

59-
- XML
60-
- remote configuration
61-
- improved http (server side support)
58+
- XML
59+
- remote configuration
60+
- improved http (server side support)
6261

6362
## Random picks from change log ##
6463

6564
Some other highlights from the change log:
6665

67-
- Real time event log checking
68-
- Brand new (easy to use?) command line interface
69-
- Linux support
70-
- New installer
71-
- Reworked CheckWMi with nice command line syntax as well as remote check support
72-
- Almost 10.000 unit tests (ish)
73-
- Many many more things...
66+
- Real time event log checking
67+
- Brand new (easy to use?) command line interface
68+
- Linux support
69+
- New installer
70+
- Reworked CheckWMi with nice command line syntax as well as remote check support
71+
- Almost 10.000 unit tests (ish)
72+
- Many many more things...

‎docs/about/whatsnew/0.4.1.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,18 @@ Just a final reminder the configuration file format has changed but the old (nsc
1414

1515
## Checks ##
1616

17-
In the check department we have a lot of new features. in general the shift towards real-time monitoring is continuing as well as the focus to modernize and provide platform independence for checks. The first brand new platform independent module is ChecklogFile which provides similar features as CheckEventLog for checking text (log) files. This module has a new improved syntax over CheckEventlog which will be added to CheckEventlog (and many other modules as well) if deemed a good interface.
18-
To seamlessly integrate real-time monitoring in "active" (aka NRPE) style setups we have provided another new module called SimpleCache which can be used to store real-time results for checking via for instance NRPE.
17+
In the check department we have a lot of new features. in general the shift towards real-time monitoring is continuing as well as the focus to modernize and provide platform independence for checks. The first brand new platform independent module is [ChecklogFile](../../reference/check/CheckLogFile.md) which provides similar features as [CheckEventLog](../../reference/windows/CheckEventLog.md) for checking text (log) files. This module has a new improved syntax over [CheckEventLog](../../reference/windows/CheckEventLog.md) which will be added to [CheckEventLog](../../reference/windows/CheckEventLog.md) (and many other modules as well) if deemed a good interface.
18+
To seamlessly integrate real-time monitoring in "active" (aka NRPE) style setups we have provided another new module called [SimpleCache](../../reference/generic/SimpleCache.md) which can be used to store real-time results for checking via for instance NRPE.
1919
The combination with the cache and the two log file checks provides a way to efficiently process massive file with millions of lines without impacting system performance.
20-
In addition to this we also introduce the SimpleFileWriter module which can direct the results to a file similar to what NSCA server does on Linux. This means in theory NSClient++ could now replace NSCA server component.
20+
In addition to this we also introduce the [SimpleFileWriter](../../reference/generic/SimpleFileWriter.md) module which can direct the results to a file similar to what NSCA server does on Linux. This means in theory NSClient++ could now replace NSCA server component.
2121
In addition to this there is there usual myriad of bug fixes and enhancements.
2222
The most notable enchantment is the performance counters which are now working (again) on various localized windows.
2323
Also don't forget to look into the various command line helpers such as `nscp sys --help" and "nscp eventlog --help` and `nscp wmi --help` for helping you diagnose and configure checks as well as even provide unit testing for your monitoring environment.
2424

2525
## Protocols ##
2626

2727
On the protocol side the main focus has been on security as well as fixing various bugs in the new protocol stack introduced in 0.4.0.
28-
This means we now have FULL ssl support including certificate based authentication. I would almost dare say that finally the tag line from the logo "secure monitoring deamon" is finally true!
28+
This means we now have FULL ssl support including certificate based authentication. I would almost dare say that finally the tag line from the logo "secure monitoring daemon" is finally true!
2929
In addition to this we have introduced check_mk support (both client and server) as well we NRDP and Graphite.
3030
Other notable fixes and enchantments include full ipv6 support as well as retry handling to better cater for network issues as well as proper timeout handling.
3131

‎docs/about/whatsnew/0.4.2.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@ The main goal of the 0.4.2 update is to create a new modern check subsystem.
44

55
This means all checks will get:
66

7-
- help command line options to get help
8-
- proper documentation
9-
- the same or similar syntax
10-
- "real-time" options in many instances
7+
- help command line options to get help
8+
- proper documentation
9+
- the same or similar syntax
10+
- "real-time" options in many instances
1111

1212
## Documentation ##
1313

@@ -17,10 +17,10 @@ Completely new documentation tool chain (your reading the result).
1717

1818
The windows subsystem in < 0.4.2 is optimized for Windows NT and really needs an overhaul.
1919

20-
- Support for remote checking of windows machines (i.e. allow NSCLient++ act as a broker and check remote machines in an agent-less fashion)
21-
- Support for Modern Windows (vista and beyond)
22-
- Drop support for "Legacy Windows" (will still be available as-is in but not updated/get extended support)
23-
- Support real-time monitoring in more instances
20+
- Support for remote checking of windows machines (i.e. allow NSClient++ act as a broker and check remote machines in an agent-less fashion)
21+
- Support for Modern Windows (vista and beyond)
22+
- Drop support for "Legacy Windows" (will still be available as-is in but not updated/get extended support)
23+
- Support real-time monitoring in more instances
2424

2525

2626
## New Syntax ##
@@ -35,15 +35,15 @@ CheckCPU MaxWarn=80% MaxCrit=90%
3535
check_cpu "warn=load > 80%" "crit=load > 90%"
3636
```
3737

38-
The first thing to realise is that the old commands still work as they will be migrated automatically for you.
38+
The first thing to realize is that the old commands still work as they will be migrated automatically for you.
3939
Also all new commands have _ instead of CamelCase of check_cpu is the new version of CheckCPU.
4040

4141
Migrating the thresholds is pretty simple as well as most old thresholds are of the form Max/Min crit this or that. and then you just replace them as above.
4242

4343
## Sensible defaults ##
4444

4545
Another change is that all new commands now have a sensible default.
46-
For instance check_cpu will work without arguments.
46+
For instance `check_cpu` will work without arguments.
4747

4848
```
4949
check_cpu

‎docs/about/whatsnew/0.4.3.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
# What's New in NSClient++ 0.4.3 #
1+
# What's New in NSClient++ 0.4.3
22

33
The main goals of the 0.4.3 was stability and fix all outstanding issues and annoyances and any new issues from 0.4.2.
44

5-
- Enhanced Usability
6-
- Bug-fixes
7-
- WEB UI
8-
- REST Support
9-
- Deprecated insecure legacy check_nrpe SSL
10-
- Linux Packages
5+
- Enhanced Usability
6+
- Bug-fixes
7+
- WEB UI
8+
- REST Support
9+
- Deprecated insecure legacy `check_nrpe` SSL
10+
- Linux Packages
1111

1212
!!! danger "PLEASE NOTE"
1313
NRPE has been changed, for details read below.
1414

15-
## Enhanced Usability ##
15+
## Enhanced Usability
1616

1717
A lot of effort has been spent on making command line syntax behave better and more consistently and allow to easily configure things.
1818

19-
## Bug-fixes ##
19+
## Bug-fixes
2020

2121
A lot of bugs have been fixed especially in terms of compatibility with older commands.
2222
The modules have been changed to use shared code which reduces the memory consumption by up to 50%.
2323
Lastly the usual bug fixes and enhancements: see change-log for details.
2424

25-
## WEB UI ##
25+
## WEB UI
2626

2727
A brand new web UI has been added which will make configuring and administrating NSClient++ much easier.
2828

@@ -31,7 +31,7 @@ A brand new web UI has been added which will make configuring and administrating
3131
With the advent of the new webui which features a web version of the really nifty "test mode" client the client has been enhanced to support a lot of new features.
3232
Such as listing commands, modules, loading/unloading modules and so on and so forth.
3333

34-
## REST Support ##
34+
## REST Support
3535

3636
The main goal for the webui was really to create a REST API.
3737
The webui is fully REST driven which means anything you can do in the webui you can also do on your own from a script or central station.
@@ -46,7 +46,7 @@ curl
4646
https://localhost:8443/query/check_cpu?show-all
4747
```
4848

49-
## NRPE enhancements ##
49+
## NRPE enhancements
5050

5151
I have spent a lot of time enhancing the NRPE experience for instance the multi package patch is enabled by default.
5252
Adding security and certificates is now much easier.
@@ -69,14 +69,14 @@ In 0.4.3 we will no longer support the rather insecure regular NRPE!
6969
You can still enable support but you have to do so (in the installer or using the command line mode).
7070
So keep a heads up when you run the installer so you wont miss it.
7171

72-
The idea is that when NSClient++ ships a new check_nrpe will be provided which wont have the limitations of the old one.
72+
The idea is that when NSClient++ ships a new `check_nrpe` will be provided which wont have the limitations of the old one.
7373

74-
## Dot-net love! ##
74+
## Dot-net love!
7575

7676
Dot net has received some well deserved love and now actually works, there is even built-in protobuf support which means you no longer need to hand craft messages or use JSON.
7777
We also proved and build a sample plugin so you can see how to do it.
7878
I think this is the longest overdue feature.
7979

80-
## JSON! ##
80+
## JSON!
8181

8282
All protobuf messages now map directly to corresponding protobuf messages which means you can now if you like use JSON for everything instead of protobuf if you are writing scripts.

0 commit comments

Comments
 (0)
Please sign in to comment.