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-17803 site: fix frontmatter errs, add docker build #3873

Merged
merged 2 commits into from
Jul 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Units: pixels, ems, display resolution
title: 'Units: pixels, ems, display resolution'
---

# Units: pixels, ems, display resolution
Expand Down Expand Up @@ -37,4 +37,4 @@ Some reference material:
- https://en.wikipedia.org/wiki/Pixel_density
- https://en.wikipedia.org/wiki/Em_(typography)

![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)
![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)
12 changes: 6 additions & 6 deletions docs/site/translation/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
---
title: @Getting Started
title: Getting Started
---

# @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)
- [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)
- [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)
![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)
52 changes: 26 additions & 26 deletions docs/site/translation/getting-started/vetting-view.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Survey Tool: Dashboard tips
title: 'Survey Tool: Dashboard tips'
---

# Survey Tool: Dashboard tips
Expand All @@ -15,38 +15,38 @@ The Dashboard will show you a list of data items with warnings of different kind
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.
- 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.
- 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.
- 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.
- 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.
- 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.)
- **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.
- Please provide them. (High priority.)
- Please provide them. (High priority.)
- **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:

- A blue field which links to the relevant value in the Survey Tool. The link will open in a new window.
- 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:

1. 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.
1. 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.
2. 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.
Expand All @@ -59,15 +59,15 @@ The rest of this page discusses how to do the Priority Items. Once you have done

Remember to periodically look at the Forum for your locale.

1. On any page in your locale, near the top there is a link "[Forum](https://cldr.unicode.org/translation/getting-started/guide#TOC-Forum)".
2. Click on it and go through the comments.
1. On any page in your locale, near the top there is a link "[Forum](https://cldr.unicode.org/translation/getting-started/guide#TOC-Forum)".
2. Click on it and go through the comments.
3. If there is a request to change values or votes, either respond on the Forum with why you disagree, or change your vote.
4. 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.

1. Go to each Section in the survey tool
2. Check that related items (like singular/plural) don't have spurious differences
2. Check that related items (like singular/plural) don't have spurious differences
3. Check that closely related items have consistent translations.

## Priority Items
Expand All @@ -80,7 +80,7 @@ Click on Priority Items. After it loads you’ll see a view over all the possibl

- _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 |
Expand All @@ -107,15 +107,15 @@ Data Submission Phase

1. Concentrate on fixing the Missing items first, since you can't fix them in the Vetting phase.
2. You can then work on Error, Warning and Unsync'ed items.


Vetting Phase

1. Review the New items and Unsync'ed items to make sure that they make sense.
2. Work on getting of the Error, Losing, Disputed counts down to zero.
1. The Warning and Unsync'd counts might not be zero after you are done.
1. 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](https://cldr.unicode.org/index/process#TOC-Data--Resolution).
Expand All @@ -126,39 +126,39 @@ Handle each of the types of issues as follows:

### Missing\* (only applicable during Data Submission Phase)

1. Add the missing value, or vote for an "inherited" value (in a special color)
1. Add the missing value, or vote for an "inherited" value (in a special color)
2. Unless there is some other error, you can't change these during the vetting phase, so make sure to get them done early!


### Error\*, Warning\*

1. Go to the item (by clicking the **Fix?** link).
1. Go to the item (by clicking the **Fix?** link).
2. Error items will be removed from the release, so they are a priority in the vetting phase.
3. Review the warning items; most of them need fixing but not all. See [Fixing Errors and Warnings](https://cldr.unicode.org/translation/getting-started/errors-and-warnings)


### Losing\*, Disputed\*

1. See if the winning value is ok. If so, change your vote to it, and go to the next item.
2. Otherwise, post a message to the [Forum](https://cldr.unicode.org/translation/getting-started/guide#TOC-Forum).
1. State why you think the item should be changed.
2. If there are a number of items that have the same characteristic (such as the wrong capitalization), you can make that case in a single posting rather than multiple ones.


### New\*

1. Quickly scan over these values.
2. 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

1. 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.
2. Similarly, the English was simplified for "Unknown Script"; that change should also be made to French.
2. Similarly, the English was simplified for "Unknown Script"; that change should also be made to French.
3. 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**_

Expand All @@ -179,4 +179,4 @@ For the Unsync'd issues, the older English value is listed below the new one, an

Once you have completed your items, review the Priority Items again to see that all the changes are as expected.

![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)
![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)
4 changes: 2 additions & 2 deletions docs/site/translation/miscellaneous-displaying-lists.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Miscellaneous: Displaying Lists
title: 'Miscellaneous: Displaying Lists'
---

# Miscellaneous: Displaying Lists
Expand All @@ -23,4 +23,4 @@ There may be some variance within the language. For example, there are two diffe

Pick the most neutral formulation you can, so that it works with as many kinds of noun phrases as possible.

![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)
![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)
6 changes: 3 additions & 3 deletions docs/site/translation/translation-guide-general.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: @General translation Guide
title: General translation Guide
---

# @General translation Guide
# General translation Guide

- [Capitalization](https://cldr.unicode.org/translation/translation-guide-general/capitalization)
- [Default Content](https://cldr.unicode.org/translation/translation-guide-general/default-content)
- [References](https://cldr.unicode.org/translation/translation-guide-general/references)

![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)
![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)
2 changes: 2 additions & 0 deletions tools/scripts/web/docker/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
FROM jekyll/jekyll
RUN gem install bundler github-pages kramdown-parser-gfm webrick
7 changes: 7 additions & 0 deletions tools/scripts/web/docker/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Previewing locally

1. install https://docker.io
2. `docker compose up`
3. visit <http://127.0.0.1:4000>


10 changes: 10 additions & 0 deletions tools/scripts/web/docker/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
services:
site:
build: .
command: jekyll serve -s /src -d /tmp -p 4000 --watch
ports:
- 4000:4000
volumes:
- ../../../../docs:/src
environment:
- PAGES_REPO_NWO=unicode-org/cldr
Loading