Page MenuHomePhabricator
Create Task
Maniphest T245454

Create guidelines and template for Toolforge help pages that provide information about developing in different programming languages
Closed, ResolvedPublic
Actions

Description

Pages that deal with information about developing in different programming languages are featured prominently in Toolforge documentation. The pages are lacking consistently of information and maybe lacking coverage of specific languages or topics.

  1. Determine if there is appropriate representation for common languages used to develop with Toolforge
  2. A template for these pages should be developed to convey quality information about programming in different languages.
  3. Include relevant information and examples and how-tos

Related Objects
Search...

Event Timeline

• srodlund created this task.Feb 17 2020, 6:43 PM
Pavithraes mentioned this in T233478: Develop a mechanism to send Wikimedia-specific Zulip welcome messages to newcomers.Mar 5 2020, 6:22 PM
• srodlund removed • srodlund as the assignee of this task.Jun 25 2020, 8:08 PM
Aklapper mentioned this in T211729: Update and improve: https://wikitech.wikimedia.org/wiki/Help:Toolforge/How_to.Mar 22 2022, 1:18 PM
TBurmeister changed the task status from Open to In Progress.Aug 21 2023, 6:15 PM
TBurmeister claimed this task.
TBurmeister triaged this task as Medium priority.
TBurmeister edited parent tasks, added: T341364: Update Toolforge docs structure and landing pages; removed: T230440: Update Toolforge and Cloud VPS Help pages.
TBurmeister added a comment.Aug 28 2023, 9:06 PM

I am building out a category structure for documentation specific to individual programming languages on Wikitech:
https://wikitech.wikimedia.org/wiki/Category:Programming_languages

I am also building out categories for how-to and tutorial document types; pages within those categories are sorted by programming language:
https://wikitech.wikimedia.org/wiki/Category:Tutorials
https://wikitech.wikimedia.org/wiki/Category:How-to-guide

Right now, I'm only working on applying it to the Toolforge documents, but if I encounter other content (or if you do!) the programming language categories can serve as a way to bring together all pages by language.

TBurmeister closed this task as Resolved.Sep 13 2023, 4:28 PM

Based on consultation with WMCS team and bd808, the intent of these programming-language specific how-to pages was to provide supplemental information to the other, generic documentation in docs like https://wikitech.wikimedia.org/wiki/Help:Toolforge/Jobs_framework and https://wikitech.wikimedia.org/wiki/Help:Toolforge/Web. So, while the information for each programming language differs, that is due to the nuances of the languages and using them with Toolforge -- trying to standardize across all languages wouldn't make sense.

One thing that can now be standardized is: any programming-language-specific documentation should have category metadata so it appears in https://wikitech.wikimedia.org/wiki/Category:Programming_languages.

In the Toolforge navigation (https://wikitech.wikimedia.org/wiki/Template:Toolforge_nav): only include 4 of the most-used languages, and base that on the most current data we have, like responses to the annual Cloud Services survey questions that ask which languages/frameworks people are using, toolinfo records, etc.

TBurmeister added a project: Tech-Docs-Team.Sep 13 2023, 4:28 PM
TBurmeister moved this task from Backlog to Done on the Tech-Docs-Team board.
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits