PlatyPS doesn’t support localized headers.
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- powershell
- Domain
- documentation
Research direction
Start with platyPS.schema.md and reproduce the reported build using a localized H2 such as “Description” in a cmdlet/ref Markdown file. Trace the validation error for the localized header; done means the schema accepts localized H2 titles and the build passes without reverting them to English.
Written by the indexing model from the issue text.
Description
Issue:
Currently PowerShell cmdlet/ref schema does not allow localization of header text, including H2 texts. This causes the localized ref topics fail publishing to docs.
Request
Docs - Update PowerSehll cmdlet/ref content schema to support localizing H2 titles in markdown files
Current Workaround:
We have to revert the translated H2 headers for all locales back to English in order to pass the build but this requires lots of unnecessary manual work that creates broken experiences for our international customers.
Steps to reproduce
Localize H2 headers such as “Description”, “Examples”, and “Parameters” and do a build
Expected behavior
Build passes successfully
Actual behavior
Build fails.
Failed builds:
---------------https://opbuildstorageprod.blob.core.windows.net/report/2019%5C10%5C14%5Cbf5577a1-a2a2-6319-05ac-9b87e96c60b5%5CCommit%5C201910140856127553-live-sxs%5Cworkflow_report.html?sv=2016-05-31&sr=b&sig=bZOi65PTJjc97VVw6qY%2Bw%2BqgBG%2F48ef0NA6KVIJEZhY%3D&st=2019-10-14T18%3A25%3A01Z&se=2019-11-14T18%3A30%3A01Z&sp=r Error msg sample: 1267 error(s) (1267 System), 1 warning(s) (1 User). Failed to parse exchange-ps/exchange/active-directory/Get-ADServerSettings.md due to :2:(0) '## ÜbersichtÜbersichtSYNOPSIS, please use PlatyPS to do content validation...
Needed feature update: Please update this schema https://raw.githubusercontent.com/PowerShell/platyPS/master/platyPS.schema.md, to enable localization of H2 header texts in PowerShell cmdlet/ref in markdown files. ## SYNOPSIS ## SYNTAX ## DESCRIPTION ## EXAMPLES ## PARAMETERS ## RELATED LINKS
Reference Bug:
Bug 131188I
Screenshot of the issue:
Comments:
Please take a look at the reference bug mentioned above. It has all the detail background information.
Priority
High
- Dominant language
- C#
- Stars
- 870
- Forks
- 166
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from PowerShell/platyPS
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
PowerShell/platyPS#868 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
PowerShell/platyPS#857 ·
-
Difficulty 3/5 Half a day Newbie friendliness 68/100
PowerShell/platyPS#867 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 62/100
PowerShell/platyPS#863 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 72/100
PowerShell/platyPS#862 ·
All issues in PowerShell/platyPS
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
Maintainers usually reply within 1 day
-
[Docs] README/PRIVACY still name AppCenter although v1.5.6.0+ uses the Microsoft Store Services SDKOpen
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
swisstopo/swissgeol-boreholes-suite#3086 ·
Maintainers usually reply within 1 day
-
[Bug]: wiki jump bugOpenbug
Difficulty 1/5 Under an hour Newbie friendliness 65/100
Maintainers usually reply within 1 day
-
frontend
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Altinn/altinn-studio#21355 ·
Maintainers usually reply within 1 day