Merge pull request #17 from Enatec/develop

[1.0.11] - 2019-02-01

Author: jhochwald

.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# These owners will be the default owners for everything in
+# the repo. The owners will be requested for review when
+# someone opens a pull request.
+*   @Enatec/core

.gitignore

@@ -1,3 +1,6 @@
+# Internal Release Notes
+*GitHubChangelog.txt
+
 # General
 *.tmp
 _ReSharper*

.vscode/settings.json

@@ -1,19 +1,19 @@
 {
-	//-------- Files configuration --------
-	// When enabled, will trim trailing whitespace when you save a file.
-	"files.trimTrailingWhitespace": true,
-	"search.exclude": {
-		"release": true,
-		"": true
-	},
-	//-------- PowerShell Configuration --------
-	// Use a custom PowerShell Script Analyzer settings file for this workspace.
-	// Relative paths for this setting are always relative to the workspace root dir.
-	"powershell.scriptAnalysis.settingsPath": "ScriptAnalyzerSettings.psd1",
-	// TNo focus on console when executing
-	"powershell.integratedConsole.focusConsoleOnExecute": false,
-	// Don't start integrated console on startup
-	"powershell.integratedConsole.showOnStartup": false,
-	// Assume files are PowerShell by default
-	"files.defaultLanguage": "powershell"
+   //-------- Files configuration --------
+   // When enabled, will trim trailing whitespace when you save a file.
+   "files.trimTrailingWhitespace": true,
+   "search.exclude": {
+      "release": true,
+      "": true
+   },
+   //-------- PowerShell Configuration --------
+   // Use a custom PowerShell Script Analyzer settings file for this workspace.
+   // Relative paths for this setting are always relative to the workspace root dir.
+   "powershell.scriptAnalysis.settingsPath": "ScriptAnalyzerSettings.psd1",
+   // TNo focus on console when executing
+   "powershell.integratedConsole.focusConsoleOnExecute": false,
+   // Don't start integrated console on startup
+   "powershell.integratedConsole.showOnStartup": false,
+   // Assume files are PowerShell by default
+   "files.defaultLanguage": "powershell"
 }

Acknowledgements.md

@@ -4,12 +4,22 @@ This project owes some acknowlegement to others. Here are some other authors, pr
 
 If you believe you or a project should be included in this list please let us know.
 
-### Idea
+## Idea
 
-This project is based on the idea of the [PHP API client class](https://github.com/Art-of-WiFi/UniFi-API-client) implementation from [Art of WiFi](http://artofwifi.net/). If you want to implement a PHP based solution, take a look at the GitHub project of the [PHP API client class](https://github.com/Art-of-WiFi/UniFi-API-client) implementation from [Art of WiFi](http://artofwifi.net/).
+This project is based on the idea of the [PHP API client class](https://github.com/Art-of-WiFi/UniFi-API-client) implementation from [Art of WiFi](http://artofwifi.net/).
 
-### PowerShell
+If you want to implement a Web/PHP based solution, take a look at the GitHub project of the [PHP API client class](https://github.com/Art-of-WiFi/UniFi-API-client) implementation from [Art of WiFi](http://artofwifi.net/).
 
+## Vendor Reference
+
+The UniFi SDN controller API as it is published by [Ubiquiti](www.ubnt.com):
+`https://dl.ubnt.com/downloads/unifi/<UniFi SDN Controller version number>/unifi_sh_api` 
+
+Example: [https://dl.ubnt.com/unifi/5.9.29/unifi_sh_api](https://dl.ubnt.com/unifi/5.9.29/unifi_sh_api) for the UniFi SDN controller version 5.9.29.
+
+## PowerShell
+
+- [ChangelogManagement](https://github.com/natescherer/ChangelogManagement) - A PowerShell module for reading and manipulating changelog files in [keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.
 - [BuildHelpers](https://github.com/RamblingCookieMonster/BuildHelpers) - Helper functions for PowerShell CI/CD scenarios
 - [Pester](https://github.com/pester/Pester) - Pester is the ubiquitous test and mock framework for PowerShell. All my automated tests are based on Pester
 - [platyPS](https://github.com/PowerShell/platyPS) - Write PowerShell External Help in Markdown
@@ -19,20 +29,23 @@ This project is based on the idea of the [PHP API client class](https://github.c
 - [PSScriptAnalyzer](https://github.com/PowerShell/PSScriptAnalyzer) - PSScriptAnalyzer is a static code checker for Windows PowerShell modules and scripts.
 - [PowerShell](https://github.com/PowerShell/PowerShell) - The Community is awesome! *And: Thank you Microsoft for make it Open Source*
 
-### General
+## General
 
-- [Visual Studio Code](https://code.visualstudio.com/) - Cross platform and very extensible code editor. *And: Thank you Microsoft for make it Open Source*
-- [Advanced Installer](http://www.advancedinstaller.com/) - For a free [Advanced Installer Professional](https://www.advancedinstaller.com/top-professional-features.html) license
-- [TeamCity](https://www.jetbrains.com/teamcity/) - Build Server (Powerful Continuous Integration out of the box)
+- [Visual Studio Code](https://code.visualstudio.com/) - Cross platform and very extensible code editor.
+- [Advanced Installer](http://www.advancedinstaller.com/) - For a _free_ [Advanced Installer Professional](https://www.advancedinstaller.com/top-professional-features.html) license for the nabling Technology open source projects
+- [TeamCity](https://www.jetbrains.com/teamcity/) - The enabling Technology Build Server (Very powerful Continuous Integration out of the box)
 - [Mark Text](https://marktext.github.io/website/) - Cross platform visual markdown editor. Free and Open Source.
 - [MacDown](https://macdown.uranusjr.com) - A great macOS visual markdown editor. Free and Open Source.
 
-### Services
+## Services
 
-- [GitHub](https://github.com) - Well you see it :-)
+- [GitHub](https://github.com) - Hosts all the enabling Technology open source projects
+- [Microsoft Teams](https://products.office.com/en-us/microsoft-teams/group-chat-software) - Team Collaboration and notification
 
-### Style and Guide
+## Styles and Guides
 
 - [PowerShell Practice and Style](https://poshcode.gitbooks.io/powershell-practice-and-style/) - The Unofficial PowerShell Best Practices and Style Guide and a great starting point.
+- [Produce clean & maintainable code](https://www.ncsc.gov.uk/guidance/produce-clean-maintainable-code) - Produce clean & maintainable code by National Cyber Security Centre
+- [OWASP Secure Coding Practices](https://www.owasp.org/index.php/OWASP_Secure_Coding_Practices_-_Quick_Reference_Guide) - The Open Web Application Security Project Secure Coding Practices Quick Reference
 - [Semantic Versioning](https://semver.org/spec/v2.0.0.html) - The source of the `MAJOR.MINOR.PATCH` guidance
 - [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - The basic idea of our changelog organisation.