Hej hej,
as you may remember from previous[1] posts[2], we (Alex[3], Bryan[4], Sarah[5], Tricia[6], and me[7]) are working on a developer portal for technical documentation[8] and updating key technical documents. The goal is to make it easier for everyone to find the help and information you need about the technical side of MediaWiki software and Wikimedia projects and to improve the overall quality and discoverability of technical documentation.
I'm going to share what has happened over the last months (also see the general schedule[9]).
Regarding the technical stack, we decided on a platform[10]. Its work- in-progress codebase is in Gerrit[11] and there might be a demo server soon[12]. This is the technical scaffold; actual content will be added when we get closer to launching in a few months (see the corresponding task graph[13] for work to sort out before launching).
We defined core audiences[14] and had nine user tests completed[15] so far. The feedback helped iterate on the Developer Portal content layout draft prototype[16] (which evolved from a unified to a multipage approach).
We are also in the process of reviewing and improving many key technical documentation pages (which will get linked from the developer portal). These updates and accuracy checks are based on a review checklist[17]. The checklist may also be helpful for anyone else interested in good technical documentation. For planning documentation review work, we use a Phabricator workboard[18]; you can also find the list of key pages on the project wiki page[19].
To get involved, sign up[20] to participate in user testing for the developer portal. For questions and feedback, leave us a comment on the project talk page[21].
All these efforts are part of the goal to have discoverable docs and paths to entry[22].
Cheers, andre
[1] https://lists.wikimedia.org/hyperkitty/list/wikitech-l@lists.wikimedia.org/m... [2] https://lists.wikimedia.org/hyperkitty/list/wikitech-l@lists.wikimedia.org/m... [3] https://meta.wikimedia.org/wiki/User:APaskulin_(WMF) [4] https://meta.wikimedia.org/wiki/User:BDavis_(WMF) [5] https://meta.wikimedia.org/wiki/User:SRodlund_(WMF) [6] https://meta.wikimedia.org/wiki/User:TBurmeister_(WMF) [7] https://meta.wikimedia.org/wiki/User:AKlapper_(WMF) [8] https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal [9] https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal#Timeline [10] https://phabricator.wikimedia.org/T287175 [11] https://gerrit.wikimedia.org/g/wikimedia/developer-portal/ [12] https://phabricator.wikimedia.org/T297800 [13] https://phabricator.wikimedia.org/T261510 [14] https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal#Core_audi... [15] https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal/Call_for_... [16] https://apaskulin.github.io/wmf-dev-portal-draft/ [17] https://www.mediawiki.org/wiki/Documentation/Review_template [18] https://phabricator.wikimedia.org/project/profile/5409/ [19] https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal#Key_landi... [20] https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal/Call_for_... [21] https://www.mediawiki.org/wiki/Talk:Developer_Advocacy/Developer_Portal [22] https://www.mediawiki.org/wiki/Wikimedia_Technology/Annual_Plans/ERF_OKR:_Te...
Hi!
Will the content of this portal be translatable? How will the translation process work?
There are a lot of links in the email. It's possible that the answer to my question is somewhere in these links. I tried clicking some of them and couldn't find it.
-- Amir Elisha Aharoni · אָמִיר אֱלִישָׁע אַהֲרוֹנִי http://aharoni.wordpress.com “We're living in pieces, I want to live in peace.” – T. Moore
בתאריך יום ו׳, 17 בדצמ׳ 2021 ב-9:10 מאת Andre Klapper < aklapper@wikimedia.org>:
Hej hej,
as you may remember from previous https://lists.wikimedia.org/hyperkitty/list/wikitech-l@lists.wikimedia.org/message/YIIXKY455DCOFIF63BARD2BJEGIC7YF3/ posts https://lists.wikimedia.org/hyperkitty/list/wikitech-l@lists.wikimedia.org/message/XBNIH2Q3WJG5ECZXVBKGNCIB6GJ4KHX4/, we (Alex https://meta.wikimedia.org/wiki/User:APaskulin_(WMF), Bryan https://meta.wikimedia.org/wiki/User:BDavis_(WMF), Sarah https://meta.wikimedia.org/wiki/User:SRodlund_(WMF), Tricia https://meta.wikimedia.org/wiki/User:TBurmeister_(WMF), and me https://meta.wikimedia.org/wiki/User:AKlapper_(WMF)) are working on a developer portal for technical documentation https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal and updating key technical documents. The goal is to make it easier for everyone to find the help and information you need about the technical side of MediaWiki software and Wikimedia projects and to improve the overall quality and discoverability of technical documentation.
I'm going to share what has happened over the last months (also see the general schedule https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal#Timeline ).
Regarding the technical stack, we decided on a platform https://phabricator.wikimedia.org/T287175. Its work-in-progress codebase is in Gerrit https://gerrit.wikimedia.org/g/wikimedia/developer-portal/ and there might be a demo server https://phabricator.wikimedia.org/T297800 soon. This is the technical scaffold; actual content will be added when we get closer to launching in a few months (see the corresponding task graph https://phabricator.wikimedia.org/T261510 for work to sort out before launching).
We defined core audiences https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal#Core_audiences and had nine user tests completed https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal/Call_for_feedback_and_testing so far. The feedback helped iterate on the Developer Portal content layout draft prototype https://apaskulin.github.io/wmf-dev-portal-draft/ (which evolved from a unified to a multipage approach).
We are also in the process of reviewing and improving many key technical documentation pages (which will get linked from the developer portal). These updates and accuracy checks are based on a review checklist https://www.mediawiki.org/wiki/Documentation/Review_template. The checklist may also be helpful for anyone else interested in good technical documentation. For planning documentation review work, we use a Phabricator workboard https://phabricator.wikimedia.org/project/profile/5409/; you can also find the list of key pages on the project wiki page https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal#Key_landing_pages .
To get involved, sign up https://www.mediawiki.org/wiki/Developer_Advocacy/Developer_Portal/Call_for_feedback_and_testing#We_could_use_your_help! to participate in user testing for the developer portal. For questions and feedback, leave us a comment on the project talk page https://www.mediawiki.org/wiki/Talk:Developer_Advocacy/Developer_Portal.
All these efforts are part of the goal to have discoverable docs and paths to entry https://www.mediawiki.org/wiki/Wikimedia_Technology/Annual_Plans/ERF_OKR:_Tech_Community_Building .
Cheers, andre
--
Andre Klapper (he/him) | Bugwrangler / Developer Advocate https://blogs.gnome.org/aklapper/ http://blogs.gnome.org/aklapper/
Wikitech-l mailing list -- wikitech-l@lists.wikimedia.org To unsubscribe send an email to wikitech-l-leave@lists.wikimedia.org https://lists.wikimedia.org/postorius/lists/wikitech-l.lists.wikimedia.org/
On Wed, Dec 22, 2021 at 12:52 PM Amir E. Aharoni amir.aharoni@mail.huji.ac.il wrote:
Will the content of this portal be translatable? How will the translation process work?
Yes, the portal is being designed with localization in mind. Our intent is to register as a translatewiki.net (TWN) project to allow translations of the English source content. We expect the translation workflow to look much like the workflow for any software project at TWN using GNU PO files as the translation dictionary. Our messages will be using Markdown syntax rather than MediaWiki syntax for things like links, bold, and italic. This is something that we will need to document at TWN or elsewhere for translators.
We evaluated an existing plugin for translation of mkdocs projects in our initial proof of concept work. The evaluation convinced us that things could be made to work, but that we would need to create our own plugin with changes intended to make it easier to integrate with TWN. The current plugin work is tracked in https://phabricator.wikimedia.org/T297168 and https://gerrit.wikimedia.org/r/c/wikimedia/developer-portal/+/747214/.
Bryan
wikitech-l@lists.wikimedia.org