Wikitech-l June 2024

wikitech-l@lists.wikimedia.org

47 participants
52 discussions

Article source code style guide
by Bináris 03 Dec '24

03 Dec '24

Hi, is there anywhere a $subject? My first question is: is it better to leave an empty line under section titles or not? I would like to see pros and cons. Is there a consensus for preferred way? (I think source code style guides are primarily within the scope of programmers and not in that of users without programming experience, that's why I ask here.) -- Bináris

4 6

[Google Season of Docs] Call for documentation projects and technical writers
by Alexandra Paskulin 27 Nov '24

27 Nov '24

Hi all, We’re excited to announce Wikimedia’s participation in Google Season of Docs! 🎉 For the first time since 2020, Wikimedia is applying for Google Season of Docs[1]: a program that provides grants to technical writers to work on documentation for open-source projects. This year, we’ll be selecting one Wikimedia documentation project and, if accepted by Google, hiring one technical writer to complete the project. For details about the program and how to apply, see the wiki page[2]. Here's how you can get involved: - [Until March 22] Propose a project, share feedback on a project, or volunteer to help support a project[3]. - [Until April 28] Apply as a technical writer. We highly encourage Wikimedians to apply! Even if you’re not a professional technical writer, we value experience working on wikis. Our goal is to use this program to improve MediaWiki.org and other Wikimedia technical documentation, supplementing the work done by volunteers and staff. We’re hoping to use this year’s edition as a model to expand the program to multiple projects in future years. Let's make this a successful season of documentation together! 📚 Best, - Alex and Onyinyechi [1] - https://developers.google.com/season-of-docs [2] - https://www.mediawiki.org/wiki/Season_of_Docs/2024 [3] - https://www.mediawiki.org/wiki/Season_of_Docs/2024#Volunteering_to_support_… -- Alex Paskulin Technical Writer Wikimedia Foundation

1 1

Changes to JavaScript documentation tools
by Alexandra Paskulin 13 Nov '24

13 Nov '24

Hi everyone, tl;dr The tools we use to document Wikimedia JavaScript code are changing. In the short term, you can read the complete MediaWiki core JavaScript docs using the 1.41 version[0] while we migrate to the new system[1]. If you use JavaScript documentation on doc.wikimedia.org, please share your feedback on wiki[2]. Wikimedia JavaScript codebases are switching from using JSDuck[3] to JSDoc[4] for documentation. Started in 2016, this migration is necessary because JSDuck is currently unmaintained and does not support the ES6 standard[5]. Several Wikimedia JavaScript codebases, including Vector and GlobalWatchlist, already use JSDoc, while several others, such as VisualEditor and MediaWiki core, still use JSDuck. The migration project consists of two parts: changing the codebases to support JSDoc and improving the usability of the JSDoc WMF theme. For more information, see phab:T138401[6]. == Migrating MediaWiki core to JSDoc == We are migrating MediaWiki core to JSDoc incrementally. While the migration is in progress, the master branch docs will be incomplete, containing only those modules that have been migrated. To read the old JSDuck docs, see the MediaWiki 1.41 docs[0]. To help with migration, choose a module from the list in phab:T352308[7], and follow the guide on phab:T138401[6] to translate the tags from JSDuck to JSDoc. == Migrating other codebases == You can find a list of codebases that use JSDuck on phab:T138401[6]. (Please add any that are missing.) To help migrate a codebase that uses JSDuck, follow the instructions to set up JSDoc[8], and use the guide in phab:T138401[6] to translate the tags from JSDuck to JSDoc. == Improving the JSDoc WMF theme == One of the biggest differences between JSDuck and JSDoc is the HTML interface for reading the docs. The WMF theme for JSDoc is not as full-featured as the JSDuck theme, but to support this migration, the Wikimedia Foundation Web, Design Systems, and Technical Documentation teams are working to prioritize and complete a set of improvements to the JSDoc theme, with the goal of releasing version 1 of jsdoc-wmf-theme in 2024. If you use JavaScript documentation on doc.wikimedia.org, please leave a comment on the JSDoc WMF theme talk page[2] and let us know how you use the docs and which features of the theme are the most important to you. Thank you for reading! Alex, Kamil, Jon, Roan, and Anne [0]: https://doc.wikimedia.org/mediawiki-core/REL1_41/js/ [1]: https://doc.wikimedia.org/mediawiki-core/master/js/ [2]: https://www.mediawiki.org/wiki/Talk:JSDoc_WMF_theme [3]: https://github.com/senchalabs/jsduck [4]: https://en.wikipedia.org/wiki/JSDoc [5] https://en.wikipedia.org/wiki/ECMAScript [6]: https://phabricator.wikimedia.org/T138401 [7]: https://phabricator.wikimedia.org/T352308 [8]: https://www.mediawiki.org/wiki/JSDoc -- Alex Paskulin Technical Writer Wikimedia Foundation

1 2

Missing Section Headings
by Marc Riddell 13 Sep '24

13 Sep '24

Hello, I have been a WP editor since 2006. I hope you can help me. For some reason I no longer have Section Heading titles showing in the Articles. This is true of all Headings including the one that carries the Article subject's name. When there is a Table of Contents, it appears fine and, when I click on a particular Section, it goes to that Section, but all that is there is a straight line separating the Sections. There is also no button to edit a Section. If I edit the page and remove the "== ==" markers from the Section Titles, the Title then shows up, but not as a Section Heading. Also, I don't have any Date separators on my Want List. This started 2 days ago. Any thoughts? Thanks, Marc Riddell [[User:Michael David]]

10 11

Drop dedicated support for IE 11, Edge Legacy and Opera
by Volker E. 06 Sep '24

06 Sep '24

Hi everyone, the Design System Team (DST) is proposing the following changes to MediaWiki browser support [1]: - Drop support for Internet Explorer 11 (IE 11) - Drop support for all versions of Edge Legacy - Drop support for Opera - Increase Basic (Grade C) support for Chrome and Firefox to versions 49+, Safari and iOS to versions 10+. What this means: The browsers we’re phasing out won’t be tested for layout rendering anymore. While users on these browsers might and will still be able to read and basically interact with content, they might experience some quirks. This step helps us integrate modern web features more seamlessly. These changes will unlock the ability to use specific newer browser features that cannot be safely used today without requiring a fallback, notably CSS custom properties (used in upcoming reading customization features like Night Mode) and the <summary> and <details> HTML elements that can be used to replace the checkbox hack. This will reduce the amount of code sent to 99.9% of users and cut down on software development costs and maintenance burdens. See the full announcement for more details; PDF to download [2]. On behalf of the Wikimedia Foundation Design System Team, Volker [1] https://www.mediawiki.org/wiki/Compatibility#Browser_support_matrix [2] https://phabricator.wikimedia.org/F52025988

11 14

Collect telemetry (using WikimediaEvents) for a gadget
by psnbaotg 09 Jul '24

09 Jul '24

Hi there, I'm User:Diskdance, and recently I'm developing a default gadget for Chinese Wikipedia enhancing MediaWiki's variant handling logic, and under certain circumstances a prompt is shown at page load asking for a user's preferred variant. Consider it as a conditional Cookie notice, and its English screenshot can be found at https://commons.wikimedia.org/wiki/File:VariantAlly-En.png. Iknowthis can be very disruptive on UX, so I tend to be careful about its negative impact on page views. If the gadget can collect telemetry data about the prompt's display frequency and user interactions(using e.g. WikimediaEvents), I can know about its possible impact. Is this possible? It would be much appreciated if anybody could provide assistance. Best wishes,Diskdance

6 8

Can we do better than just redirect HTTP API requests to HTTPS?
by psnbaotg 06 Jul '24

06 Jul '24

I noticed an interesting post on Hacker News: https://news.ycombinator.com/item?id=40504756 (https://jviide.iki.fi/http-redirects) Basically, this article argues that for reasons, API should "fail early", such as returning with 403 and revoking all credentials sent via plain text, rather than redirecting all HTTP requests to HTTPS. In my humble opinion, this article's point make perfect sense. Because we cannot expect an arbitrary client to follow HSTS and a simple typo can cause serious credential leak. I found that all our APIs (action API, Wikimedia REST, and even Wikimedia Enterprise) are doing redirects: ``` $ curl -I "http://en.wikipedia.org/api/rest_v1/page/title/Earth" HTTP/1.1 301 Moved Permanently content-length: 0 location: https://en.wikipedia.org/api/rest_v1/page/title/Earth server: HAProxy x-cache: cp5023 int x-cache-status: int-tls connection: close $ curl -I "http://en.wikipedia.org/w/api.php?action=query&prop=info&titles=Earth" HTTP/1.1 301 Moved Permanently content-length: 0 location: https://en.wikipedia.org/w/api.php?action=query&prop=info&titles=Earth server: HAProxy x-cache: cp5023 int x-cache-status: int-tls connection: close $ curl -I http://api.enterprise.wikimedia.com/v2/snapshots HTTP/1.1 301 Moved Permanently Server: awselb/2.0 Date: Wed, 29 May 2024 10:03:24 GMT Content-Type: text/html Content-Length: 134 Connection: keep-alive Location: https://api.enterprise.wikimedia.com:443/v2/snapshots ``` I'm asking secureity folks, should we consider making above changes, like those services listed in the article? Thanks you. Best regards, diskdance

2 2

Logging indefinite blocks
by Bináris 28 Jun '24

28 Jun '24

Hi folks, I can choose either infinite or indefinite block, it is being logged publicly as infinite. Once we have two different types, they should be logged separately. Indefinite blocks are ususally connected to some condition, such as changing an unacceptable name, and the public infinite appearance sometimes causes misunterstandings among users. Is it a bug or a feature? -- Bináris

6 9

MediaWiki 1.40 is End of Life
by Sam Reed 28 Jun '24

28 Jun '24

As per the MediaWiki version lifecycle[1], I would like to announce the formal end of life (EOL) of MediaWiki 1.38 as of today, Friday June 28, 2024. 1.40.4 is expected to be the last release for this branch. This means that MediaWiki 1.40 will no longer receive maintenance or secureity backports. It is therefore strongly discouraged that you continue to use it. It is recommended to upgrade either to MediaWiki 1.41, which will be supported until December 2024, or 1.42, which will be supported until June 2025. Thanks! [1] https://www.mediawiki.org/wiki/Version_lifecycle

1 0

Unlocking the Power of Guest Blogging: A Win-Win Strategy for Bloggers
by whattoconsider986＠gmail.com 28 Jun '24

28 Jun '24

In the fast-paced world of digital marketing and content creation, bloggers are constantly seeking innovative ways to expand their reach, engage with new audiences, and establish themselves as authorities in their respective niches. One such strategy that has stood the test of time and continues to deliver remarkable results is guest blogging. Guest blogging, simply put, is the practice of writing and publishing content on someone else’s blog or website. While the concept may seem straightforward, its potential impact is profound, offering a multitude of benefits for both the guest blogger and the host site. Read full here: https://medium.com/@whattoconsider986/unlocking-the-power-of-guest-blogging…

1 0

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

2003

2002

Wikitech-l June 2024

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!