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

CLDR-17566 converting getting started p1 #3813

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/site/TEMP-TEXT-FILES/errors-and-warnings.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,27 @@ Handling Errors and Warnings
Errors
Errors in the survey tool MUST be fixed for the Winning column. Following are common errors that you may encounter and tips on ways to fixing them.
Can't have same translation as… (Must fix)
Exactly the same name can't be used for two different items of the same type.
Exactly the same name can't be used for two different items of the same type.
For example, it is an error if "Malawi-Kwacha" is used as the translation for two different currency codes:
MZN (Mozambican metical), and
MWK (Malawian Kwachas)
In the above case, it is a pretty clear mistake. It is not as simple in other cases. Some region names are very similar, for example, and it can be a bit tricky to know how to handle them. Currencies have the problem that a new currency code may have the same name as an obsolete one.
You can find some guidance under "Unique Names" in the following pages:
Country/Region Names,
City Names,
Country/Region Names,
City Names,
Currency Symbols & Names
The characters ‎[…]‎ should not be used (Must fix)
For what to do, see Characters, in the section Handling Warnings. While these are categorized as warnings, every effort should be made to fix them.
Unquoted special character '.' in pattern (Must fix)
Number patterns can only contain an unquoted . when it is the decimal separator.
In other cases, such as to finish an abbreviation, it must be quoted, as in: 000 tūkst'.'
In other cases, such as to finish an abbreviation, it must be quoted, as in: 000 tūkst'.'
For more information, see Number Patterns.
Errors in Others column can be ignored. For example, this is an example of an Inheritance value in the Others column where the Language (Country/region) names have a collision issue. Do not vote on values that have errors.
alt-text
Copy link
Member

Choose a reason for hiding this comment

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

The introduction of "alt-text" looks like an error.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

alt-text is just what shows up in the text file for any images when I copy directly from the output of markdown. I try to clean them up for the most part but they aren't in the actual md files.

Copy link
Member

Choose a reason for hiding this comment

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

got it

Warnings
The value is the same as in English
Because a common mistake is for people to copy the English values precisely, a warning is provided when this happens.
This may not be an error, because it is often perfectly legitimate to have an identical string. For example, the word for "France" in French is the same as English, for example. So this warning is just to call your attention to the text in case it needs to be changed.
The value is the same as 'code'
Another common mistake is to copy a code value, such as "cs" for Czech, instead of translating it.
Another common mistake is to copy a code value, such as "cs" for Czech, instead of translating it.
This may not be an error, because it is often perfectly legitimate to have an identical string.For example the script code for "Thai" is "Thai", which matches the English word exactly. So this warning is just to call your attention to the text in case it needs to be changed.
2 changes: 1 addition & 1 deletion docs/site/TEMP-TEXT-FILES/getting-started.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
@Getting Started
Before getting started to contribute data in CLDR, and jumping in to using the Survey Tool, it is important that you understand the CLDR process.
Before getting started to contribute data in CLDR, and jumping in to using the Survey Tool, it is important that you understand the CLDR process.
Understand the basics about the CLDR process and the community-based model and the Technical Committee. Read: CLDR Process
Read the Getting Started topics on the Information Hub:
Survey Tool Guide
Expand Down
124 changes: 77 additions & 47 deletions docs/site/TEMP-TEXT-FILES/guide.txt

Large diffs are not rendered by default.

19 changes: 6 additions & 13 deletions docs/site/TEMP-TEXT-FILES/survey-tool-phases.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,44 +5,37 @@ Shakedown
General submission
Vetting
Resolution
Full vs. Limited Submission
Full vs. Limited Submission
There are two types of releases: full, and limited-submission.
Full-submission:
Typically with the even versions (e.g. Version 36).
All languages and data areas are open for contributions.
All languages and data areas are open for contributions.
Limited-submission
Typically with odd versions (e.g. version 37).
Selected fields are open for all locales; the voting options will be grayed out for those data points that are not in scope.
Proceed with Submission (General), but start with the Dashboard and focus on Errors*, Missing†, Provisional
Selected locales are open for votes on all fields.
Proceed with Submission (General).
Contents
Stages
Full vs. Limited Submission
Survey Tool phase: Shakedown
Survey Tool phase: General Submission
Survey Tool phase: Vetting
Resolution (Closed to vetters)
Proceed with Submission (General).
Survey Tool phase: Shakedown
Make sure your coverage level is set correctly at the top of the page.
Shakedown is on an invitation basis. If you have not received an invitation to participate in shakedown, your participation is discouraged.
You should know in this stage:
The survey tool is live and all data that you enter will be saved and used.
You can start work
Expect a churn: there may be additional Tooling fixes and Data additions during this period.
Expect a churn: there may be additional Tooling fixes and Data additions during this period.
Tool may be taken down for updates more frequently during general submission
You are expected to look for issues with the Survey tool and any other problems you encounter as a vetter. Please file a ticket.
Survey Tool phase: General Submission
Make sure your coverage level is set correctly at the top of the page.
For new locales or ones where the goal is to increase the level, it is best to proceed page-by-page starting with the Core Data section. At the top of each page you can see the number of items open on the page. Then scan down the page to see all the places where you need to vote (including adding items). Some
For new locales or ones where the goal is to increase the level, it is best to proceed page-by-page starting with the Core Data section. At the top of each page you can see the number of items open on the page. Then scan down the page to see all the places where you need to vote (including adding items). Some
Then please focus on the Dashboard view,
Get all Missing† items entered
Vote for all Provisional items (where you haven't already voted)
Address any remaining Errors*
Review the English Changed (where the English value changed, but your locale's value didn't. These may need adjustment.)
* Note that if the committee finds systematic errors in data, new tests can be added during the submission period, resulting in new Errors.
† Among the Missing are are new items for translation. (On the Dashboard, New means winning values that have changed since the last release.)
If you are working in a sub-locales (such as fr_CA), coordinate with others on the Forum to work on each section after it is are done in the main locale (fr). That way you avoid additional work and gratuitous differences. See voting for inheritance vs. hard votes in Survey Tool guide.
If you are working in a sub-locales (such as fr_CA), coordinate with others on the Forum to work on each section after it is are done in the main locale (fr). That way you avoid additional work and gratuitous differences. See voting for inheritance vs. hard votes in Survey Tool guide.
Survey Tool phase: Vetting
All contributors are encourage to move their focus to the Dashboard view. Also see Dashboard tips to use during Vetting stage.
Any Flagged entries in your locale may have questions in the Forum from TC members; please add additional information to help the TC resolve them.
Expand Down
47 changes: 33 additions & 14 deletions docs/site/TEMP-TEXT-FILES/vetting-view.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,50 +6,58 @@ Dashboard Sections
The Dashboard is divided in these sections. If a section is not visible for you, that means you have no items in that section:
Error: The currently winning value has caused an error in validation that will have to be resolved before release. (High priority.)
Fix the error. In some cases there is a conflict among items, and you'll need to fix the conflicting item, not the one showing the error.
Losing: Your vote is losing against the other vetters’ vote.
Can you live with the winning value? If so, change your vote.
Losing: Your vote is losing against the other vetters’ vote.
Can you live with the winning value? If so, change your vote.
Otherwise, use the forum to alert the other vetters and reach consensus.
Disputed: Your vote is winning, but other vetters voted differently.
Use the forum to help reach consensus if possible.
Warning: The winning value has something unexpected in it, perhaps a character that’s not normally used in your language.
Warning: The winning value has something unexpected in it, perhaps a character that’s not normally used in your language.
Please review. If it’s an unwarranted warning, you can hide it.
English Changed: The English value changed from last version, but the winning translation in your language remained the same.
English Changed: The English value changed from last version, but the winning translation in your language remained the same.
Does the translation need to be updated? If not, you can hide the warning.
New: The winning localized value is different from last year. (Informational.)
Missing: We have no localized value for these values.
Missing: We have no localized value for these values.
Please provide them. (High priority.)
Provisional: We have a value, but not enough votes to support it and include them in the release.
Provisional: We have a value, but not enough votes to support it and include them in the release.
Add your vote if you haven’t already and alert other vetters through the forum to support if you have already voted.
Fixing Entries
Each entry has the following:
Each entry has the following:
A blue field which links to the relevant value in the Survey Tool. The link will open in a new window.
English value
previous CLDR version’s value
currently winning value
Clearing Items
There are two ways to clear items from the list:
There are two ways to clear items from the list:
The preferred way is to fix them (such as adding a translation for a missing item). Click on the item line to bring up that item in the Survey Tool where you can change or edit your vote, or post a forum vote to try to convince the other vetters to change their vote for losing or disputed items.
The other is to hide them (such as when the English has changed but the translation doesn’t need to change). Only hide an item if it really is a false positive, not because you gave up on fixing it. To hide an item from view, click on the checkbox on the far right of the item. Note that this will not make it disappear, just hide it from view. Click on the check box next to 'Hide' on the Dashboard menu to hide or unhide hidden lines. The count on each section will show how many items are showing versus the total.
The following are legacy tools to review votes, but the Priority Items tool is deprecated in favor of the Dashboard. This information is presented here for reference.
Review: Priority Items |Date/Time | Zones | Numbers
You can also see a video walkthrough of the review sections on Walkthrough.
The rest of this page discusses how to do the Priority Items. Once you have done the Priority Items, Review reports.
Remember to periodically look at the Forum for your locale.
Remember to periodically look at the Forum for your locale.
On any page in your locale, near the top there is a link "Forum".
Click on it and go through the comments.
If there is a request to change values or votes, either respond on the Forum with why you disagree, or change your vote.
Some issues may be general, such as the capitalization of language names. In the vetting period, please try to resolve these in accordance with the other items in the locale for consistency; leave anything else for the next release.
Some issues may be general, such as the capitalization of language names. In the vetting period, please try to resolve these in accordance with the other items in the locale for consistency; leave anything else for the next release.
If you have time after doing the above, it is useful to review items for consistency.
Go to each Section in the survey tool
Check that related items (like singular/plural) don't have spurious differences
Check that closely related items have consistent translations.
Priority Items
Open your locale, such as https://st.unicode.org/cldr-apps/v#/de//, and log in.
Click on Priority Items. After it loads you’ll see a view over all the possible issues for your locale. Once it loads you can leave it open while you work through the items, so you won’t have to reload very often.
Warning:
Warning:
Make sure your coverage level is set correctly: typically modern*. Otherwise you won't see all the issues for your language.
After you change your coverage, or to see the new status of changed items, you must click the Refresh Values button.
In the Priority view, you can see the important issues for your language. At the top is a summary for each kind of issue, looking something like the following:
Count Abbr. Description
0 ☐ Error* The Survey Tool detected an error in the winning value.
411 ☐ Losing* The value that your organization chose (overall) is either not the winning value, or doesn't have enough votes to be approved.
4 ☐ Disputed* There is a dispute between other organizations that needs your help in resolving to the best value.
0 ☐ Warning* The Survey Tool detected a warning about the winning value.
265 ☐ Unsync’d* The English value changed at some point in CLDR, but the corresponding value for your language didn’t.
130 ☐ New* The winning value was altered from the last-released CLDR value.
36 ☐ Missing* Your current coverage level requires the item to be present, but it is missing.
It is followed by a list of issues, categorized by type.
How to Proceed
You will click on each of the check-boxes above that that don't have a count of zero, and follow the instructions below.
Expand All @@ -64,7 +72,7 @@ Work on getting of the Error, Losing, Disputed counts down to zero.
The Warning and Unsync'd counts might not be zero after you are done.
The count for New items is informative, it just represents the changes in this release. You do not have to try to reduce it.
Go through the summary list, clicking the checkbox (☑) to show the issues of type you're working on. You can click several at once if you find that easier. That will then expose the issues of that type below the summary.
After the data submission phase, any differences in the submitted data will be resolved according to the data resolution process.
After the data submission phase, any differences in the submitted data will be resolved according to the data resolution process.
How to Handle
Handle each of the types of issues as follows:
Missing* (only applicable during Data Submission Phase)
Expand All @@ -84,10 +92,21 @@ Quickly scan over these values.
If the values are ok, then you don't need to do anything. If not, follow the instructions above.
Unsync’d*
For the Unsync'd issues, the older English value is listed below the new one, and in Red. (See below). These often indicate that a change needs to be made in your language. For example, in the tables below
The English value was changed so that the locale "zh-Hans" shows up as "Chinese (Simplified)" rather than the somewhat redundant "Chinese (Simplified Han)". The corresponding change should be made to French.
The English value was changed so that the locale "zh-Hans" shows up as "Chinese (Simplified)" rather than the somewhat redundant "Chinese (Simplified Han)". The corresponding change should be made to French.
Similarly, the English was simplified for "Unknown Script"; that change should also be made to French.
On the other hand, the change for that particular currency name in English is specific to English, and doesn't need to be reflected in French.
Section: names — Page: script
No. Code English CLDR 1.9.1 Winning 2.0 Fix?
358 Hans Simplified
Simplified Han idéogrammes han simplifiés = Unsync’d*
359 Hant Traditional
Traditional Han idéogrammes han traditionnels = Unsync’d*
360 Zzzz Unknown Script
Unknown or Invalid Script écriture inconnue ou non valide = Unsync’d*
Section: names — Subsection: currency
No. Code English CLDR 1.9.1 Winning 2.0 Fix?
... ... ... ... ... ...
29 BIF:name Burundian Franc
Burundi Franc franc burundais = Unsync’d*
Review
Once you have completed your items, review the Priority Items again to see that all the changes are as expected.
Once you have completed your items, review the Priority Items again to see that all the changes are as expected.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/errors-and-warnings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/gettingStartedGuideAgree.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/gettingStartedGuideArabic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/gettingStartedGuideAutoAgree.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/gettingStartedGuideBrazil.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/gettingStartedGuideColorCode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/gettingStartedGuideComment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/gettingStartedGuideCookies.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/gettingStartedGuideCoverage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/gettingStartedGuideDashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/gettingStartedGuideEnglish.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/gettingStartedGuideForum.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/gettingStartedGuideICUSyntax.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/gettingStartedGuideIcon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/gettingStartedGuideKorean.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/gettingStartedGuidePatterns.jpeg
Binary file added docs/site/images/gettingStartedGuideReasons.png
Binary file added docs/site/images/gettingStartedGuideRequest.png
Binary file added docs/site/images/gettingStartedGuideSideBar.png
Binary file added docs/site/images/gettingStartedGuideSpanish.jpg
Binary file added docs/site/images/gettingStartedGuideVote.png
Binary file added docs/site/images/gettingStartedGuideVoteCol.jpeg
24 changes: 24 additions & 0 deletions docs/site/translation/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: @Getting Started
---

# @Getting Started

Before getting started to contribute data in CLDR, and jumping in to using the Survey Tool, it is important that you understand the CLDR process.

1. Understand the basics about the CLDR process and the community-based model and the Technical Committee. Read: [CLDR Process](https://cldr.unicode.org/index/process)
2. Read the Getting Started topics on the Information Hub:
- [Survey Tool Guide](https://cldr.unicode.org/translation/getting-started/guide)
- [Survey Tool Stages](https://cldr.unicode.org/translation/getting-started/survey-tool-phases)
- [Handling Errors and Warnings](https://cldr.unicode.org/translation/getting-started/errors-and-warnings)
- [Handling Logical Group Errors](https://cldr.unicode.org/translation/getting-started/resolving-errors)
- [Plurals & Units](https://cldr.unicode.org/translation/getting-started/plurals)
- [Review Date & Time](https://cldr.unicode.org/translation/date-time)
- [Review Numbers](https://cldr.unicode.org/translation/number-currency-formats)
- [Review Zones](https://cldr.unicode.org/translation/time-zones-and-city-names)
- [Data stability](https://cldr.unicode.org/translation/getting-started/data-stability)
- [Empty cache](https://cldr.unicode.org/translation/getting-started/empty-cache)

\*If you (individual or your organization) have not established a connection with the CLDR technical committee, start with [Survey Tool Accounts](https://cldr.unicode.org/index/survey-tool/survey-tool-accounts).

![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)
Loading