Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some globalization recommendations for best practices. #40492

Merged
merged 10 commits into from
Apr 28, 2024

Conversation

Clockwork-Muse
Copy link
Contributor

@Clockwork-Muse Clockwork-Muse commented Apr 16, 2024

Summary

This issue is the documentation side of attempting to deal with issues submitted to the runtime about globalization data errors.

Most of the original text from the original runtime PR was already available in various parts of the existing globalization documentation; so far this PR has only adjusted the best-practices documentation.

Do we still fill we need a small "initial troubleshooting" doc?

cc @jkotas @tarekgh @ericstj


Internal previews

📄 File 🔗 Preview link
docs/core/extensions/best-practices-for-developing-world-ready-apps.md Best practices for developing world-ready applications
docs/core/extensions/globalization-icu.md "Globalization and ICU"

@dotnet-bot dotnet-bot added this to the April 2024 milestone Apr 16, 2024
@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates PR is created by someone from the .NET community. label Apr 16, 2024
@Clockwork-Muse
Copy link
Contributor Author

Status checker is complaining about 2 remaining absolute links, but neither link is part of this repo. What's the way I should handle it? Still make it relative, assuming that those links would normally be part of the same root regardless?

@IEvangelist
Copy link
Member

Status checker is complaining about 2 remaining absolute links, but neither link is part of this repo. What's the way I should handle it? Still make it relative, assuming that those links would normally be part of the same root regardless?

Anything that has the learn.microsoft.com host should be relative link instead.

Copy link
Member

@IEvangelist IEvangelist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are good additions, thank you! I have some nits and suggestions for improvement, after that I think we can :shipit:.

@Clockwork-Muse
Copy link
Contributor Author

Clockwork-Muse commented Apr 22, 2024

@jkotas @IEvangelist -
I have a section that reads:

"The data for a culture isn't what it should be!"

The ICU libraries use the Unicode Common Locale Data Repository (CLDR) as a datasource. This data is not maintained by the runtime SDK, nor (outside of legacy Windows applications) by the host OS. If you believe there is an error in the data, please follow the CLDR directions on submitting a ticket.

Some of the issues that get reported on the main runtime repo are about this sort of thing. I feel like I maybe want to point people at the CLDR for this sort of thing, but I'm not quite sure where. I can add it to the runtime bug template (or a ███ could auto-reply), or as a footnote to one of the globalization files here. Thoughts?

Note

This content was automatically updated to filter out profanity. If you feel as though this was done in error, please file an issue with the details.

@jkotas
Copy link
Member

jkotas commented Apr 22, 2024

Some of the issues that get reported on the main runtime repo are about this sort of thing. I feel like I maybe want to point people at the CLDR for this sort of thing, but I'm not quite sure where. I can add it to the runtime bug template (or a ███ could auto-reply), or as a footnote to one of the globalization files here. Thoughts?

Linking to CLDR as the data source in the docs is good idea. I would avoid duplicating instruction for how to file tickets against CLDR in .NET docs. The instructions for that are not that hard to find in the CLDR page. I think it is a good idea to make people slow down and think a bit more before they file CLDR issue to avoid creating noise in the CLDR issue tracker.

I do not think we need to automate this. It is good enough to have a response like
"This globalization issue is by design. Please check for more information." that a human uses to close the issue. (Some of our feature teams have a catalog of standard responses like this that they use to close frequently filled by-design issues.)

Clockwork-Muse and others added 2 commits April 27, 2024 19:00
Co-authored-by: Jan Kotas <jkotas@microsoft.com>
@jkotas jkotas requested a review from tarekgh April 28, 2024 02:50
Windows currently customizes some CLDR data
@tarekgh tarekgh merged commit be2836e into dotnet:main Apr 28, 2024
8 checks passed
@Clockwork-Muse Clockwork-Muse deleted the globalization-recommendations branch April 29, 2024 01:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-contribution Indicates PR is created by someone from the .NET community. dotnet-fundamentals/svc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants