Update rule docs for removed API rules (#43)

This commit is contained in:
Bernie White 2020-02-18 13:22:22 +10:00 коммит произвёл GitHub
Родитель 67dd802456
Коммит bc8248c6b8
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
3 изменённых файлов: 6 добавлений и 4 удалений

Просмотреть файл

@ -5,7 +5,7 @@ Document 'module' {
Title 'Module rule reference'
Import-Module .\out\modules\PSRule.Rules.Kubernetes
$rules = Get-PSRule -Module PSRule.Rules.Kubernetes -WarningAction SilentlyContinue |
$rules = Get-PSRule -Module PSRule.Rules.Kubernetes -WarningAction SilentlyContinue -Baseline AKS |
Add-Member -MemberType ScriptProperty -Name Category -Value { $this.Info.Annotations.category } -PassThru |
Sort-Object -Property Category;

Просмотреть файл

@ -8,7 +8,9 @@ The following rules are included within `PSRule.Rules.Kubernetes`.
Name | Synopsis | Severity
---- | -------- | --------
[Kubernetes.API.Removal](Kubernetes.API.Removal.md) | Avoid using legacy API endpoints. | Important
[Kubernetes.API.v1.16](Kubernetes.API.v1.16.md) | Avoid using legacy API endpoints not served by Kubernetes v1.16. | Important
[Kubernetes.API.v1.17](Kubernetes.API.v1.17.md) | Avoid using legacy API endpoints not served by Kubernetes v1.17. | Important
[Kubernetes.API.v1.20](Kubernetes.API.v1.20.md) | Avoid using legacy API endpoints not served by Kubernetes v1.20. | Important
### Management

Просмотреть файл

@ -275,7 +275,7 @@ task Analyze Build, PSScriptAnalyzer, {
# Synopsis: Build table of content for rules
task BuildRuleDocs Build, PSRule, PSDocs, {
Import-Module (Join-Path -Path $PWD -ChildPath out/modules/PSRule.Rules.Kubernetes) -Force;
$Null = Invoke-PSDocument -Name module -OutputPath .\docs\rules\en-US\ -Path .\RuleToc.Doc.ps1;
$Null = Invoke-PSDocument -Name module -OutputPath .\docs\rules\en\ -Path .\RuleToc.Doc.ps1;
}
# Synopsis: Build help
@ -290,7 +290,7 @@ task BuildHelp BuildModule, PlatyPS, {
task ScaffoldHelp Build, BuildRuleDocs, {
# Import-Module (Join-Path -Path $PWD -ChildPath out/modules/PSRule.Rules.Kubernetes) -Force;
# Update-MarkdownHelp -Path '.\docs\commands\PSRule.Rules.Kubernetes\en-US';
# Update-MarkdownHelp -Path '.\docs\commands\PSRule.Rules.Kubernetes\en';
}
# Synopsis: Add shipit build tag