Write localization/internationalization mkdocs plugin
Closed, ResolvedPublic
Actions

Assigned To

Authored By

	bd808
	Dec 6 2021, 10:40 PM

Description

Implement an mkdocs plugin that will:

maintain a "primary" GNU Portable Object (PO) file in the git repo based on English language content added by editors
generate internationalized static pages based on PO files found in the git repo

Details

	Project	Branch	Lines +/-	Subject
	wikimedia/developer-portal	main	+1 K -1	Content localization plugin

Customize query in gerrit

Related Objects
Search...

Status	Subtype	Assigned	Task
Resolved		Aklapper	T265018 Update redirect target of dev.wikimedia.org to Developer Portal
Resolved		Aklapper	T265019 Update several on-wiki link targets for "Developers" links (sidebars, footer, pages)
Resolved		Aklapper	T286568 Communicate launch
Resolved		Aklapper	T302809 Add dev portal to list of microsites on doc.wikimedia.org
Open		None	T299923 Update Zulip's welcomebot message and GSoC organization contact to point to dev portal
Resolved		Aklapper	T287030 Update or remove meta:Wikimedia_Resource_Center/For_developers
Resolved		Aklapper	T265017 Once developer.wikimedia.org is up, make https://www.mediawiki.org/wiki/API:Web_APIs_hub redirect to it
Resolved		Aklapper	T261510 Launch MVP of Developer Portal on https://developer.wikimedia.org/
Resolved		Aklapper	T306832 Create documentation for contributors
Resolved		Aklapper	T290254 Workflow how to add/edit content
Resolved		Aklapper	T276702 Workflow how to propose content changes
Resolved		Aklapper	T303987 Create documentation for translators
Resolved		None	T290256 Workflow for translators how to translate content
Resolved		bd808	T276700 Content localization infrastructure setup (export, import, deploy)
Resolved		bd808	T276708 Define content storage format (levels, data structure, hierarchy, categorization, etc)
Resolved	BUG REPORT	bd808	T309113 Static pages fail to build when the active locale is not also supported by mkdocs-material theme
Resolved		abi_	T308236 Add "Wikimedia Developer Portal" to translatewiki.net
Resolved		bd808	T297168 Write localization/internationalization mkdocs plugin
Resolved	Spike	bd808	T295832 Evaluate improving/replacing mkdocs-mdpo-plugin to better support TWN integration

Event Timeline

bd808 created this task.Dec 6 2021, 10:40 PM

Restricted Application added a project: User-bd808. · View Herald TranscriptDec 6 2021, 10:40 PM

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

bd808 changed the task status from Open to In Progress.Dec 6 2021, 10:41 PM

bd808 triaged this task as High priority.

bd808 added a subtask: T295832: Evaluate improving/replacing mkdocs-mdpo-plugin to better support TWN integration.

bd808 added parent tasks: T290256: Workflow for translators how to translate content, T276708: Define content storage format (levels, data structure, hierarchy, categorization, etc).

My initial design for this is plugin is that it should do something like:

configure theme languages based on po files found on disk
create a temp directory outside of docs_dir for generated files
add navigation strings to the English translation catalog
generate .md files for all (Page, language) pairs where language != English
let mkdocs find all the generated pages
if md target language is English, add messages to English translation catalog
if md target language is not English, translate md using po

These steps will be scattered across multiple mkdocs callbacks so that each happens in a place where other plugins and mkdocs built-ins can find the generated content and config when needed.

bd808 mentioned this in T297167: Security team input on Wikimedia Developer Portal static site.Dec 8 2021, 8:19 PM

Change 747214 had a related patch set uploaded (by BryanDavis; author: Bryan Davis):

[wikimedia/developer-portal@main] Content localization plugin

https://gerrit.wikimedia.org/r/747214

gerritbot added a project: Patch-For-Review.Dec 14 2021, 11:54 PM

bd808 moved this task from To Do to In Dev/Progress on the User-bd808 board.Dec 21 2021, 1:21 AM

• nnikkhoui added a subscriber: • nnikkhoui.Jan 5 2022, 2:33 PM

Change 747214 merged by jenkins-bot:

[wikimedia/developer-portal@main] Content localization plugin

https://gerrit.wikimedia.org/r/747214

apaskulin mentioned this in rWDPO178d0972c414: Content localization plugin.Jan 6 2022, 11:02 PM

Maintenance_bot removed a project: Patch-For-Review.Jan 6 2022, 11:10 PM