upstream/icinga-powershell-framework
1
0
Fork 0
mirror of https://github.com/Icinga/icinga-powershell-framework.git synced 2025-12-21 07:10:15 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #469 from Icinga:feature/improve_plugin_dic_visualisation

Browse source 
Feature: Improves plugin doc generator for better docs

Adds table view for plugins with short summary of what the plugin is for and allows multi-lines in example docs
This commit is contained in:
Lord Hepipud 2022-02-08 09:16:10 +01:00 committed by GitHub
commit 901c34acba
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/100-General/10-Changelog.md
View file

@ -7,6 +7,14 @@ documentation before upgrading to a new release.
Released closed milestones can be found on [GitHub](https://github.com/Icinga/icinga-powershell-framework/milestones?state=closed). Released closed milestones can be found on [GitHub](https://github.com/Icinga/icinga-powershell-framework/milestones?state=closed).
## 1.9.0 (2022-05-03)
[Issue and PRs](https://github.com/Icinga/icinga-powershell-framework/milestone/20?closed=1)
### Enhancements
* [#469](https://github.com/Icinga/icinga-powershell-framework/pull/469) Improves plugin doc generator to allow multi-lines in code examples and updates plugin overview as table, adding a short description on what the plugin is for
## 1.8.0 (2022-02-08) ## 1.8.0 (2022-02-08)
[Issue and PRs](https://github.com/Icinga/icinga-powershell-framework/milestone/19?closed=1) [Issue and PRs](https://github.com/Icinga/icinga-powershell-framework/milestone/19?closed=1)

13
lib/core/framework/Publish-IcingaPluginDocumentation.psm1
View file

@ -47,11 +47,15 @@ function Publish-IcingaPluginDocumentation()
Add-Content -Path $PluginDocFile -Value '\_ [WARNING] Core Total: 29,14817700% is greater than threshold 20% (15m avg.)'; Add-Content -Path $PluginDocFile -Value '\_ [WARNING] Core Total: 29,14817700% is greater than threshold 20% (15m avg.)';
Add-Content -Path $PluginDocFile -Value "| 'core_total_1'=31.545677%;;;0;100 'core_total_15'=29.148177%;20;40;0;100 'core_total_5'=28.827410%;;;0;100 'core_total_20'=30.032942%;;;0;100 'core_total_3'=27.731669%;;;0;100 'core_total'=33.87817%;;;0;100"; Add-Content -Path $PluginDocFile -Value "| 'core_total_1'=31.545677%;;;0;100 'core_total_15'=29.148177%;20;40;0;100 'core_total_5'=28.827410%;;;0;100 'core_total_20'=30.032942%;;;0;100 'core_total_3'=27.731669%;;;0;100 'core_total'=33.87817%;;;0;100";
Add-Content -Path $PluginDocFile -Value '```'; Add-Content -Path $PluginDocFile -Value '```';
Add-Content -Path $PluginDocFile -Value ''
Add-Content -Path $PluginDocFile -Value '| Plugin Name | Description |'
Add-Content -Path $PluginDocFile -Value '| --- | --- |'
$AvailablePlugins = Get-ChildItem -Path $PluginDir -Recurse -Filter *.psm1; $AvailablePlugins = Get-ChildItem -Path $PluginDir -Recurse -Filter *.psm1;
foreach ($plugin in $AvailablePlugins) { foreach ($plugin in $AvailablePlugins) {
[string]$PluginName = $plugin.Name.Replace('.psm1', ''); [string]$PluginName = $plugin.Name.Replace('.psm1', '');
[string]$PluginDocName = ''; [string]$PluginDocName = '';
$PluginDetails = Get-Help -Name $PluginName -Full;
foreach ($DocFile in $MDFiles) { foreach ($DocFile in $MDFiles) {
$DocFileName = $DocFile.Name; $DocFileName = $DocFile.Name;
if ($DocFileName -Like "*$PluginName.md") { if ($DocFileName -Like "*$PluginName.md") {
@ -73,9 +77,10 @@ function Publish-IcingaPluginDocumentation()
[string]$PluginDescriptionFile = Join-Path -Path $PluginDocDir -ChildPath $PluginDocName; [string]$PluginDescriptionFile = Join-Path -Path $PluginDocDir -ChildPath $PluginDocName;
Add-Content -Path $PluginDocFile -Value ([string]::Format( Add-Content -Path $PluginDocFile -Value ([string]::Format(
'* [{0}](plugins/{1})', '| [{0}](plugins/{1}) | {2} |',
$PluginName, $PluginName,
$PluginDocName $PluginDocName,
$PluginDetails.Synopsis
)); ));
$PluginHelp = Get-Help $PluginName -Full; $PluginHelp = Get-Help $PluginName -Full;
@ -136,10 +141,6 @@ function Publish-IcingaPluginDocumentation()
foreach ($example in $PluginHelp.examples.example) { foreach ($example in $PluginHelp.examples.example) {
[string]$ExampleDescription = $example.remarks.Text; [string]$ExampleDescription = $example.remarks.Text;
if ([string]::IsNullOrEmpty($ExampleDescription) -eq $FALSE) { if ([string]::IsNullOrEmpty($ExampleDescription) -eq $FALSE) {
$ExampleDescription = $ExampleDescription.Replace("`r`n", '');
$ExampleDescription = $ExampleDescription.Replace("`r", '');
$ExampleDescription = $ExampleDescription.Replace("`n", '');
$ExampleDescription = $ExampleDescription.Replace(' ', '');
} }
Add-Content -Path $PluginDescriptionFile -Value ([string]::Format('### Example Command {0}', $ExampleIndex)); Add-Content -Path $PluginDescriptionFile -Value ([string]::Format('### Example Command {0}', $ExampleIndex));