Skip to content

Commit debb92d

Browse files
committed
Remove outdated sections on string file format, string ID format, and usage patterns from localization guidelines
1 parent 1b30f58 commit debb92d

File tree

1 file changed

+0
-25
lines changed

1 file changed

+0
-25
lines changed

.github/instructions/dsc-community-style-guidelines-mof-resource-localization.instructions.md

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,3 @@ applyTo: "source/DSCResources/**/*.psm1,source/DSCResources/**/*.strings.psd1"
99
- Create `en-US` folder in each resource directory
1010
- Name strings file: `DSC_<ResourceName>.strings.psd1`
1111
- Use names returned from `Get-UICulture` for additional language folder names
12-
13-
## String File Format
14-
```powershell
15-
# Localized resources for <ResourceName>
16-
ConvertFrom-StringData @'
17-
KeyName = Message with {0} placeholder. (PREFIX0001)
18-
'@
19-
```
20-
21-
## String ID Format
22-
Use unique IDs: `(PREFIX####)`
23-
- PREFIX: First letter of each word in resource name
24-
- ####: Sequential number starting 0001
25-
- Examples: SqlSetup → SS0001, SqlAGDatabase → SAGD0001
26-
27-
## Usage Patterns
28-
```powershell
29-
# Verbose/Warning messages
30-
Write-Verbose -Message ($script:localizedData.KeyName -f $value)
31-
Write-Warning -Message ($script:localizedData.KeyName -f $value)
32-
33-
# Error messages
34-
New-InvalidOperationException -Message ($script:localizedData.KeyName -f $value1, $value2)
35-
New-InvalidOperationException -ErrorRecord $_ -Message ($script:localizedData.KeyName -f $value1)
36-
```

0 commit comments

Comments
 (0)