Skip to content

Commit

Permalink
CLDR-17566 txt diffs and minor changes
Browse files Browse the repository at this point in the history
  • Loading branch information
chpy04 committed Sep 4, 2024
1 parent 110f5da commit ff92feb
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 34 deletions.
7 changes: 6 additions & 1 deletion docs/site/TEMP-TEXT-FILES/development-process.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Pre-Assessment for Weekly Triage
There is a pre-assessment of tickets to make the triage flow faster. This pre-assessment should be done off-line prior to every Wednesday in time for the TC triage. DO NOT fix a bug until it's been approved by the TC in triage.
The triage is a part of Monday and Wednesday meetings.
Ticket comes in, and the default is Priority=assess, Milestone=to-assess
If user sets Component (we always should!) automatically assigns the Owner based on the component owner for the pre-assessment. [Add link to Components and Owner]
If user sets Component (we always should!) automatically assigns the Owner based on the component owner for the pre-assessment. [Add link to Components and Owner]
At this point the Owner function is really as an assessor.
If user does not select the Component, it remains for the group TC triage with Component=to-assess, Owner=anybody. These tickets will be assessed after all the pre-assessed tickets have been triaged.
All TC members, look at To-assess by Owner / Component before each triage day.
Expand Down Expand Up @@ -40,6 +40,11 @@ When a ticket is in design, the owner is responsible for bringing back to the co
The Owner is responsible for documenting the results of the discussion in the TC in comments in the ticket.
The Reviewer is responsible for verifying that the design was accepted by the TC before accepting.
Phases
dsub The ticket should be completed before submission starts.
dvet The ticket should be completed before vetting starts
rc The ticket must be completed before Alpha — Final Data candidate . No change to data affecting ICU thereafter. Other dtd, data, spec, docs, tool changes allowed.
spec-beta The ticket must be completed before Beta — Final Candidate . No dtd or data changes allowed thereafter. Docs, charts, spec changes allowed (= ICU release candidate)
final The ticket must be completed before Release ( = ICU Release)
Assignees
Assignees periodically review and take care of their tickets.
Go to http://unicode.org/cldr/trac/report/61 for My Tickets
Expand Down
38 changes: 19 additions & 19 deletions docs/site/TEMP-TEXT-FILES/maven.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ At present, GitHub requires authentication even for publicly accessible reposito
The GitHub documentation covering this topic is https://docs.github.com/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages and will be referred to.
Getting Started - GitHub token
We are going to create a token. A token is used like a password, and should be kept secret as one. You can revoke a token independently from all other tokens, so we will create a token specifically for this use.
1. go to https://github.com/settings/tokens - you may need to login with a 2nd factor.
2. click "generate new token".
go to https://github.com/settings/tokens - you may need to login with a 2nd factor.
click "generate new token".
update the Note, something you will remember such as "Maven settings on my laptop"
give the token "read:packages" scope (permission).
Click the "Generate Token" button at the bottom.
Expand All @@ -23,24 +23,24 @@ Linux: sudo apt install maven
Configuring Maven
It might be helpful to refer to the GitHub documentation and the Maven documentation for settings during this step.
The file you will be modifying is .m2/settings.xml (the .m2 directory is in your HOME directory, create it if it does not exist).
If the file doesn't exist, create it with this content. If it does exist, add the <server> stanza into the <servers> section.
If the file doesn't exist, create it with this content. If it does exist, add the <server> stanza into the <servers> section.
Keep the id "githubicu" as it is. (The id "githubcldr" is for accessing CLDR's prebuilt maven assets.)
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
http://maven.apache.org/xsd/settings-1.0.0.xsd">
<servers>
<server>
<id>githubicu</id> <!-- needed for building CLDR -->
<username>your github id</username>
<password>your access token</password>
</server>
<server> <!-- used by ICU and other clients of CLDR -->
<id>githubcldr</id>
<username>your github id</username>
<password>your access token</password>
</server>
</servers>
<servers>
<server>
<id>githubicu</id> <!-- needed for building CLDR -->
<username>your github id</username>
<password>your access token</password>
</server>
<server> <!-- used by ICU and other clients of CLDR -->
<id>githubcldr</id>
<username>your github id</username>
<password>your access token</password>
</server>
</servers>
</settings>
Try It Out
In the CLDR repo root, go into the tools directory and run:
Expand All @@ -51,8 +51,8 @@ Building without running tests:
mvn package -DskipTests=true
Running specific tests:
Example to run only one test from the main unit tests and one test in the web tests: (one long command line, two separate parameters)
mvn test '-Dorg.unicode.cldr.unittest.testArgs=-f:TestUntimedCounter -n -q'
'-Dorg.unicode.cldr.unittest.web.testArgs=-f:TestMisc -n -q'
mvn test '-Dorg.unicode.cldr.unittest.testArgs=-f:TestUntimedCounter -n -q'
'-Dorg.unicode.cldr.unittest.web.testArgs=-f:TestMisc -n -q'
Peter's version:
To run ConsoleCheck for say a specific locale like "fr", I might do (from the top of the CLDR directory):
java -DCLDR_DIR=$(pwd) -jar tools/cldr-code/target/cldr-code.jar check -S common,seed -e -z BUILD -f fr
Expand All @@ -66,5 +66,5 @@ Make sure the config files are set up first (3.2 Configuring Maven), and that CL
Go to File -> Import, choose Maven and import Existing Maven Projects (see image at right)
Give the root of your CLDR checkout, and import all projects.
If you are not working on the Survey Tool, you may not need the cldr-apps and cldr-rdf projects.
To run tests, Choose Run As > Maven test on the top level (cldr-all) project, or on the cldr-code project, etc.
To start up the Survey Tool, right-click on 'cldr-apps' and choose 'Run As… Run On Server'. Create a Tomcat 9 server.
To run tests, Choose Run As > Maven test on the top level (cldr-all) project, or on the cldr-code project, etc.
To start up the Survey Tool, right-click on 'cldr-apps' and choose 'Run As… Run On Server'. Create a Tomcat 9 server.
31 changes: 23 additions & 8 deletions docs/site/TEMP-TEXT-FILES/running-tools.txt
Original file line number Diff line number Diff line change
@@ -1,12 +1,27 @@
Running Tools
Provides tools for manipulating CLDR files. Warning: these tools do not have much documentation
Provides tools for manipulating CLDR files. Warning: these tools do not have much documentation
Overview
Variables: (you'll need to set these to whatever you have on your system)
For the purposes of this document, / and \ are equivalent. Note: Directories must have a trailing slash.
Variables Here
{cldrdata}
Description
Location of cldr data root; that is, common, docs, dropbox are found here.
Example
/Users/markdavis/Documents/workspace/cldr/src/
Tools:
Variables Here Description Example
{cldrdata} Location of cldr data root; that is, common, docs, dropbox are found here. /Users/markdavis/Documents/workspace/cldr/src/
Tools:
Goal Program Name Description Arguments
Common Arguments for all of following -Dfile.encoding=UTF-8
-Xmx700M
-DSHOW_FILES
-DSHOW
-D CLDR_DIR ={cldrdata}
Testing CLDRConsole General testing of data -r
// (use -h to see options)
Canonicalizing format CLDRModify General verification of vetted data -r
// (use -h to see options)
Generating Statistics CountItems Generate something like:
 Total Items 66,319
 Total Resolved Items 1,025,077
 Unique Paths 4,717
 Unique Values 45,226
 Unique Full Paths 9,301 -Dmethod=countItems
-DSOURCE={cldrdata}\cldr_1_4\main
-Dmethod=countItems -DSOURCE={cldrdata}\incoming\vetted\main
Build most charts ShowLanguages TBD
4 changes: 2 additions & 2 deletions docs/site/development/development-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ If there is a test failure that is due to a bug that cannot be fixed right now (
***Once the statuses are all READY, anyone can push to production:***

1. ***Important!*** *Make sure the statuses are all PUSHED or READY and that the "Last Built Rev" isn't later than any items on the list*
1. *If there are any untested commits, double check the*[*timeline*](http://unicode.org/cldr/trac/timeline) *and make sure something isn't slipping in!*
1. *If there are any untested commits, double check the [timeline](http://unicode.org/cldr/trac/timeline) and make sure something isn't slipping in!*
2. ***Check*** [http://unicode.org/cldr/trac/timeline?changeset\=on\&build\=on\&daysback\=8](http://unicode.org/cldr/trac/timeline?changeset=on&build=on&daysback=8) to verify that no changes "slipped in"
3. ***Add a line PUSHING***
4. ***Push to production***
Expand All @@ -143,7 +143,7 @@ If there is a test failure that is due to a bug that cannot be fixed right now (
1. In the top right, under View Tickets, you'll see "Review \<x\> commits." Click on that to see the changed files. (Often best to to see side\-by\-side, with right\-click \> open in new window.)
2. In the **Changes** column, click on each of the items (eg, [edit](http://unicode.org/cldr/trac/changeset?old=11625&old_path=trunk%2Ftools%2Fcldr-apps&new_path=trunk%2Ftools%2Fcldr-apps&new=11627)) in each of the cells, and make sure that the implementation matches the description.
3. For data tickets, the goal is to verify that the data in the ticket matches what is entered in.
1. For spec tickets, it is often easier to go to the[Modifications section](http://unicode.org/repos/cldr/trunk/specs/ldml/tr35.html) of the latest proposed spec update, search for the modifications entry with the ticket number for the change that you are reviewing, and then click in that entry’s link to the relevant portion of the spec. The modifications in that section will be shown in yellow, and that is what you need to review.
1. For spec tickets, it is often easier to go to the [Modifications section](http://unicode.org/repos/cldr/trunk/specs/ldml/tr35.html) of the latest proposed spec update, search for the modifications entry with the ticket number for the change that you are reviewing, and then click in that entry’s link to the relevant portion of the spec. The modifications in that section will be shown in yellow, and that is what you need to review.
4. Once you are done, go back to the original ticket (you can click on it at the top), and hit "Modify Ticket" near the bottom.
1. If the implementation looks good:
- click "REVIEWER: Close as fixed", then
Expand Down
7 changes: 3 additions & 4 deletions docs/site/development/maven.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ title: Maven Setup

## Introduction

For a number of reasons, CLDR has switched to[Maven](https://maven.apache.org/).
For a number of reasons, CLDR has switched to [Maven](https://maven.apache.org/).

The purpose of this document is to assist with initial configuration of Maven.

CLDR pulls pre\-release[ICU](https://icu-project.org)4J jars from ICU's GitHub Maven repository.
CLDR pulls pre\-release [ICU](https://icu-project.org)4J jars from ICU's GitHub Maven repository.

At present, GitHub requires authentication even for publicly accessible repositories.

Expand Down Expand Up @@ -41,7 +41,7 @@ Otherwise, install the "maven" package from your OS or other package manager, or

### Configuring Maven

It might be helpful to refer to th [GitHub documentation](https://docs.github.com/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages) and the [Maven documentation](https://maven.apache.org/settings.html#Servers) for settings during this step.
It might be helpful to refer to the [GitHub documentation](https://docs.github.com/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages) and the [Maven documentation](https://maven.apache.org/settings.html#Servers) for settings during this step.

The file you will be modifying is .m2/settings.xml (the .m2 directory is in your HOME directory, create it if it does not exist).

Expand Down Expand Up @@ -114,7 +114,6 @@ mvn -DCLDR_DIR=$HOME/src/cldr exec:java -pl cldr-code -Dexec.mainClass=org.unico
2. To run the SurveyTool components you will need the IDE for Enterprise Developers, you can download this from https://www.eclipse.org/downloads/packages/
3. Make sure the config files are set up first ([**3.2** Configuring Maven](https://cldr.unicode.org/development/maven)), and that CLDR is checked out locally from git in some directory.
4. Go to File \-\> Import, choose Maven and import Existing Maven Projects (see image at right)
ma

![image](../images/development/maven1.png)

Expand Down

0 comments on commit ff92feb

Please sign in to comment.