Skip to content

Commit 36d4e0e

Browse files
committed
Adds changelog, upgradig and introduction docs
1 parent 213309e commit 36d4e0e

File tree

4 files changed

+51
-0
lines changed

4 files changed

+51
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,10 @@ $Script += "`r`n`r`n Start-IcingaFrameworkWizard;";
2222
2323
Invoke-Command -ScriptBlock ([Scriptblock]::Create($Script));
2424
```
25+
26+
## Documentation
27+
28+
Please take a look on the following content for installation and documentation:
29+
30+
* [Introduction](doc/01-Introduction.md)
31+
* [Changelog](doc/31-Changelog.md)

doc/01-Introduction.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Introduction
2+
===
3+
4+
The Icinga PowerShell Kickstart is a simple PowerShell script allowing users to easily install and deploy the [Icinga PowerShell Framwork](https://icinga.com/docs/windows/latest) on Windows machines by either using GitHub repositories or internal sources for the Zip-Package.
5+
6+
Once the Framework is installed the entire installation of Icinga Agents including many different components is possible.
7+
8+
The Kickstart script allows to specify a custom location for the script as well in case the Windows machines can not access the internet and only rely on internal resources.
9+
10+
Please have a look on the [Installation Guide of the Framework](https://icinga.com/docs/windows/latest/doc/02-Installation/) on how to proceed.

doc/30-Upgrading-Kickstart.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Upgrading Icinga PowerShell Kickstart
2+
3+
Upgrading Icinga PowerShell Kickstart is usually quite straightforward.
4+
5+
Specific version upgrades are described below. Please note that version updates are incremental.
6+
7+
## Upgrading to v1.1.0 (2020-06-02)
8+
9+
No special steps required.
10+
11+
## Upgrading to v1.0.0 (2020-02-26)
12+
13+
Initial release.

doc/31-Changelog.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Icinga PowerShell REST-Api CHANGELOG
2+
3+
**The latest release announcements are available on [https://icinga.com/blog/](https://icinga.com/blog/).**
4+
5+
Please read the [upgrading](https://icinga.com/docs/windows/latest/kickstart/doc/30-Upgrading-Kickstart)
6+
documentation before upgrading to a new release.
7+
8+
Released closed milestones can be found on [GitHub](https://github.com/Icinga/icinga-powershell-kickstart/milestones?state=closed).
9+
10+
## 1.1.0 (2020-06-02)
11+
12+
### Enhancements
13+
14+
* Updated asked questions to fit the current Icinga PowerShell Framework format
15+
* Improved visualisation for console prints to match the current Icinga PowerShell Framework version
16+
17+
## 1.0.0 (2020-02-26)
18+
19+
### Notes
20+
21+
Initial release

0 commit comments

Comments
 (0)