Skip to content

Commit bc8248c

Browse files
authored
Update rule docs for removed API rules (#43)
1 parent 67dd802 commit bc8248c

3 files changed

Lines changed: 6 additions & 4 deletions

File tree

RuleToc.Doc.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Document 'module' {
55
Title 'Module rule reference'
66

77
Import-Module .\out\modules\PSRule.Rules.Kubernetes
8-
$rules = Get-PSRule -Module PSRule.Rules.Kubernetes -WarningAction SilentlyContinue |
8+
$rules = Get-PSRule -Module PSRule.Rules.Kubernetes -WarningAction SilentlyContinue -Baseline AKS |
99
Add-Member -MemberType ScriptProperty -Name Category -Value { $this.Info.Annotations.category } -PassThru |
1010
Sort-Object -Property Category;
1111

docs/rules/en/module.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ The following rules are included within `PSRule.Rules.Kubernetes`.
88

99
Name | Synopsis | Severity
1010
---- | -------- | --------
11-
[Kubernetes.API.Removal](Kubernetes.API.Removal.md) | Avoid using legacy API endpoints. | Important
11+
[Kubernetes.API.v1.16](Kubernetes.API.v1.16.md) | Avoid using legacy API endpoints not served by Kubernetes v1.16. | Important
12+
[Kubernetes.API.v1.17](Kubernetes.API.v1.17.md) | Avoid using legacy API endpoints not served by Kubernetes v1.17. | Important
13+
[Kubernetes.API.v1.20](Kubernetes.API.v1.20.md) | Avoid using legacy API endpoints not served by Kubernetes v1.20. | Important
1214

1315
### Management
1416

pipeline.build.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ task Analyze Build, PSScriptAnalyzer, {
275275
# Synopsis: Build table of content for rules
276276
task BuildRuleDocs Build, PSRule, PSDocs, {
277277
Import-Module (Join-Path -Path $PWD -ChildPath out/modules/PSRule.Rules.Kubernetes) -Force;
278-
$Null = Invoke-PSDocument -Name module -OutputPath .\docs\rules\en-US\ -Path .\RuleToc.Doc.ps1;
278+
$Null = Invoke-PSDocument -Name module -OutputPath .\docs\rules\en\ -Path .\RuleToc.Doc.ps1;
279279
}
280280

281281
# Synopsis: Build help
@@ -290,7 +290,7 @@ task BuildHelp BuildModule, PlatyPS, {
290290

291291
task ScaffoldHelp Build, BuildRuleDocs, {
292292
# Import-Module (Join-Path -Path $PWD -ChildPath out/modules/PSRule.Rules.Kubernetes) -Force;
293-
# Update-MarkdownHelp -Path '.\docs\commands\PSRule.Rules.Kubernetes\en-US';
293+
# Update-MarkdownHelp -Path '.\docs\commands\PSRule.Rules.Kubernetes\en';
294294
}
295295

296296
# Synopsis: Add shipit build tag

0 commit comments

Comments
 (0)