ICU site redesign

23 views
Skip to first unread message

Elango Cheran

unread,
Jun 5, 2025, 8:09:19 PMJun 5
to icu-d...@unicode.org
Hi everyone,
This isn't a technical design proposal, but maybe people have opinions anyways.

The point is that ICU needs some long overdue attention, IMO. Here's my brief proposal for what I would like to do:

Let me know if you have thoughts.

-- Elango

Mark Davis Ⓤ

unread,
Jun 6, 2025, 11:01:23 AMJun 6
to Elango Cheran, icu-d...@unicode.org
Sounds good; that's what we did with CLDR; much easier to maintain (and a joy to get away from Sites). 

A few items to note:
  • There was some tooling involved, so that this goes together. Steven can point you to that if you are interested.
  • Sites doesn't really have an effective export, which is a pain
    • Part way through, Google added Copy to Markdown, and it turned out to be pretty easy for most cases to copy the body text from the HTML in Sites, paste into Google Docs, fix up there a bit, then Copy to Markdown and paste in the target .md file.
    • Tables are a pain if they have any interesting structure, such as merged cells. So part of the work in Google Docs is to change tables to a simpler format, that looks different but gets the point across.
  • Sites was also painful because it was hard to find all the files — you can't export the directory structure! We ended up using an online tool to crawl the Sites and find all the files. Every now and then we find a file that was disconnected.
  • We found it easiest to use exactly the URL structure from Sites, picking the corresponding .md file names and directories.
  • We manage the whole site organization with one file:https://github.com/unicode-org/cldr/blob/main/docs/site/sitemap.tsv. The pages are put into a visible directory structure based on that, which also is used to generate https://cldr.unicode.org/sitemap.
    • Makes it very easy to move files around in the visible directory structure without changing where files are in github. 
  • Anyway, if you are curious we have a doc the outlines the process.

--
You received this message because you are subscribed to the Google Groups "icu-design" group.
To unsubscribe from this group and stop receiving emails from it, send an email to icu-design+...@unicode.org.
To view this discussion visit https://groups.google.com/a/unicode.org/d/msgid/icu-design/CAHqn%3DU0XmHQuam6UhPFMTrR2Lz98o66hwjtvJcScW6mBa7Q6rg%40mail.gmail.com.
For more options, visit https://groups.google.com/a/unicode.org/d/optout.

Steven R. Loomis

unread,
Jun 6, 2025, 11:09:10 AMJun 6
to Mark Davis, Elango Cheran, icu-d...@unicode.org
Importantly, we are using Cloudflare Pages instead of GitHub Pages. Two major benefits:
 - redirects supported - as a plain text file
 - preview URLs, we can preview changes on a PR before deplopy

I’m not happy with how internal links are structured right now. We went with sites-friendly URLs such as “https://cldr.unicode.org/somepage” which turns into “docs/site/somepage.md”.  Currently, relative links within the site MUST be site relative ( so,  “/somepage” not “./someotherpage” nor “../parentpage” etc. ).   This also has a major downside in that the links are not navigable from Github preview., but it makes them line up with the old sites url. Yes there’s a ticket for this, it’ll require munging every page including some scary blobs of extracted HTML from sites. (The less said there the better.) 

What I need to do is change how the resolver works, probably to use ALL relative links ( no “/“ just “../“ or “./“ ) - focus it around Github’s preview (for ease of local editing/viewing), and fixup the links (which i’m already doing..) at generation time to just deal with it.  

We have a mechanism that does a local preview via docker (with automatic regeneration of the site), plus the preview on PRs as i mentioned. 

happy to walk someone through how this works. 

-s

--
Steven R. Loomis
Code Hive Tx, LLC



-- 
You received this message because you are subscribed to the Google Groups "ICU - Team" group.
To unsubscribe from this group and stop receiving emails from it, send an email to icu-team+u...@unicode.org.
To view this discussion visit https://groups.google.com/a/unicode.org/d/msgid/icu-team/CAGuL-ciVaAG1iR7iJGz3wUxUisZA0rF4YjVjCb9d1UKKd0rqYA%40mail.gmail.com.

Steven R. Loomis

unread,
Jun 6, 2025, 11:10:14 AMJun 6
to Mark Davis, Elango Cheran, icu-d...@unicode.org, 梁海 Liang Hai, Gregg Lechner
+ Liang and Gregg

--
Steven R. Loomis
Code Hive Tx, LLC


Markus Scherer

unread,
Jun 6, 2025, 4:40:35 PMJun 6
to Steven R. Loomis, Mark Davis, Elango Cheran, icu-d...@unicode.org, 梁海 Liang Hai, Gregg Lechner
+1

Steven R. Loomis

unread,
Jun 6, 2025, 6:03:58 PMJun 6
to 梁海 Liang Hai, Markus Scherer, Mark Davis, Elango Cheran, icu-d...@unicode.org, Gregg Lechner
Thanks Liang.

If I can reduce some confusion, CLDR’s current solution is bare-metal because it didn’t start from zero: it was built to match the behavior of an existing site, that is, the old google sites page with all its own quirks, but with an expectation of matching Github Pages markdown transformation.  

It’s not what I would have picked if the site was starting from scratch, or if there were (as you noted) someone responsible for proper web design.

Also note that CLDR’s SurveyTool also leverages Vue, so this was chosen to be able to share some skills between CLDR components, potentially.

If there’s a more standard Unicode layout or even stylesheet, the CLDR site could certainly be migrated. It’s based off of the Unicode site and reports stylesheet.

- s

--
Steven R. Loomis
Code Hive Tx, LLC



On Jun 6, 2025, at 4:39 PM, Liang Hai (梁海) <lian...@gmail.com> wrote:

Great to see some momentum on the ICU side.

I also recommend starting such a migration project with a documentation-oriented framework, such as Starlight (mentioned in Elango’s doc, and already used by https://icu4x.unicode.org/) or VitePress (a more matured and popular solution for Vue users).

CLDR’s current solution is confusingly bare-metal (basically a nude Vue site) for a team where no one is responsible for proper web design.

Liang


Markus Scherer

unread,
Jun 9, 2025, 12:21:41 PMJun 9
to Steven R. Loomis, 梁海 Liang Hai, Mark Davis, Elango Cheran, icu-d...@unicode.org, Gregg Lechner
On Mon, Jun 9, 2025 at 9:16 AM Steven R. Loomis <srl...@gmail.com> wrote:
Would it be worth disussing this at Unicode-Infra tomorrow? if Markus and Liang can get on (if there’s anything to discuss here)

I don't know if there is anything to discuss here with infra. If Elango wants infra-team feedback, then he and I can join.

Elango Cheran

unread,
Jun 9, 2025, 4:41:49 PMJun 9
to Markus Scherer, Steven R. Loomis, 梁海 Liang Hai, Mark Davis, icu-d...@unicode.org, Gregg Lechner
There's nothing yet to discuss. When I have a proposal with more concrete details, then let's talk about it in the infra-team. In the meantime, it would be good to see what comments, if any, that we get on the high-level plan before & during the ICU-TC meeting Thursday.

Steven R. Loomis

unread,
Jun 10, 2025, 8:23:04 AMJun 10
to Elango Cheran, Markus Scherer, 梁海 Liang Hai, Mark Davis, icu-d...@unicode.org, Gregg Lechner
Sounds good. 

Steven R. Loomis

unread,
Jun 10, 2025, 3:17:12 PMJun 10
to Steven Loomis, 梁海 Liang Hai, Markus Scherer, Mark Davis, Elango Cheran, icu-d...@unicode.org, Gregg Lechner
Would it be worth disussing this at Unicode-Infra tomorrow? if Markus and Liang can get on (if there’s anything to discuss here) 
--
Steven R. Loomis
Code Hive Tx, LLC


--
You received this message because you are subscribed to the Google Groups "icu-design" group.
To unsubscribe from this group and stop receiving emails from it, send an email to icu-design+...@unicode.org.

Elango Cheran

unread,
Jun 12, 2025, 1:50:07 PMJun 12
to Markus Scherer, Steven R. Loomis, 梁海 Liang Hai, Mark Davis, icu-d...@unicode.org, Gregg Lechner
Hi everyone,
The ICU-TC in today's meeting agreed with the proposal. Thanks for all of the info here in this thread. That will be helpful as we begin doing the work.

Speaking of which, if any of you are interested in contributing to the work, reach out to me individually. We can choose and coordinate who does what. Once we're done with everything, we will have created a good and important cross-cutting resource.

-- Elango

Steven R. Loomis

unread,
Jun 12, 2025, 5:18:02 PMJun 12
to Elango Cheran, Markus Scherer, 梁海 Liang Hai, Mark Davis, icu-d...@unicode.org, Gregg Lechner
I’m glad to hear it

for my part I’d be glad to explain anything from how CLDR”s setup works. 

--
Steven R. Loomis
Code Hive Tx, LLC


Reply all
Reply to author
Forward
0 new messages