currently a page that lists a number of tutorials and walkthroughs. (original task description changed to correctly reflect the scope of just revising / improving the How-to page).
Description
Status | Subtype | Assigned | Task | ||
---|---|---|---|---|---|
Resolved | TBurmeister | T321582 WMCS doc improvements for FY22/23: Improve the navigability, freshness, and topic coverage of Cloud Services docs | |||
Resolved | TBurmeister | T327319 Redesign Cloud Services documentation information architecture | |||
Resolved | TBurmeister | T341364 Update Toolforge docs structure and landing pages | |||
Duplicate | None | T230440 Update Toolforge and Cloud VPS Help pages | |||
Resolved | TBurmeister | T211729 Update and improve: https://wikitech.wikimedia.org/wiki/Help:Toolforge/How_to |
Event Timeline
https://wikitech.wikimedia.org/wiki/Help:Toolforge/How_to already lists tutorials per programming language. This mostly duplicates the "Developing tools" section in https://wikitech.wikimedia.org/wiki/Template:Toolforge_nav (which e.g. lacks Django or a link to https://wikitech.wikimedia.org/wiki/Help:Toolforge/Rust or Node.js ).
IMHO the page https://wikitech.wikimedia.org/wiki/Help:Toolforge/How_to should NOT exist and be removed: Unclear scope (and confusing page name).
Currently working on implementing subcategories to provide navigation to tutorials and how-to docs by language using page metadata instead of a manually-maintained page: https://wikitech.wikimedia.org/wiki/Category:Tutorials
After I create and apply categories for the different programming languages, I'll be able to deprecate https://wikitech.wikimedia.org/wiki/Help:Toolforge/How_to. The revised Toolforge nav template will provide direct links to tutorials for the most popular programming languages (as evidenced by 2022 Cloud Services User Survey responses), and will link to the Tutorials category page as a full listing (I'll go back in later and clean up the sort keys so the pages sort by the programming language instead of page title).
Created and applied category metadata to pages for:
https://wikitech.wikimedia.org/wiki/Category:Programming_languages
and
https://wikitech.wikimedia.org/wiki/Category:How-to-guide.
Next and final step is to figure out the best way to direct readers to the intersection of Toolforge category + these categories, or if that's even necessary since right now and likely for the foreseeable future, the only docs with these categories are Toolforge docs.
https://wikitech.wikimedia.org/wiki/Help:Toolforge/How_to now redirects to https://wikitech.wikimedia.org/wiki/Category:How-to-guide. I updated all incoming links to point to appropriate replacement targets.