PowerShell / PowerShell/platyPS

V2 move schema template strings to RESX to allow for localization

Open
#535 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area-Localization
Dominant language
C#
Stars
871
Forks
166
Avg merge
21h 17m
Merged PRs (30d)
1

Description

To support localization, the following strings in the schema for the template need to be localized.

  • All schema-defined headers that have labels:
    • Cmdlet schema
      • Synopsis
      • Syntax
      • Description
      • Examples
      • Example
      • Parameters
      • Common Parameters
      • Inputs
      • Input type
      • Outputs
      • Output type
      • Notes
      • Related links
    • About schema
      • Short description
      • Long description
      • See also
  • The text of the CommonParameters paragraph

NOTE: The H1 Title for both cmdlet and about_ files, and the H3 -ParameterName headings do not contain values defined by the schema. Therefore, they don't have strings that need to be localized in the PlatyPS module. Also, no strings within a YAML block should be localized. This includes frontmatter and parameter metadata.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the schema template code and its RESX resources in the PlatyPS repository. Identify the listed schema-defined labels and CommonParameters paragraph, then verify that localized resources cover them while H1 titles, parameter headings, YAML blocks, frontmatter, and parameter metadata remain unchanged.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, powershell
Domain
documentation, localization
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.