Page MenuHomePhabricator
Create Task
Maniphest T203131

Update and Improve Toolforge and Cloud VPS Technical Documentation
Open, In Progress, MediumPublic
Actions

Description

Background:

There are a plethora of open tickets requesting new and improved Technical documentation for Toolforge. Improvements to documentation have also been consistently requested in the annual Toolforge survey. Gaps in consistency and documentation have been identified by users and collaborators. Many aspects of Toolforge are well-documented and some are not documented at all. This can lead to an inconsistent experience for technical collaborators.

Proposal

  • Review and reorganize existing Toolforge and Cloud VPS technical documentation for better readability. Update outdated information for existing pages with simple updates, and file tasks for ones which require more complicated updates
  • Review, prioritize, and resolve current outstanding Phabricator tasks / requests for updates and improvements to Toolforge and Cloud VPS technical documentation
  • Seek ways to improve organization and search-ability so users can find what they need
  • Solicit additional feedback from Toolforge and Cloud VPS users regarding usefulness and accuracy of Toolforge and Cloud VPS technical documentation (qualitative interviews and survey)
  • Create and foster a feedback process, so users can surface issues with technical documentation and make requests for new technical documentation, which are addressed promptly and clearly

Related Objects
Search...

StatusSubtypeAssignedTask
 In ProgressTBurmeisterT203131 Update and Improve Toolforge and Cloud VPS Technical Documentation
 Resolved• srodlundT204130 Update and Improve https://wikitech.wikimedia.org/wiki/Help:Toolforge
 Resolved• srodlundT204132 Update and Improve: https://wikitech.wikimedia.org/wiki/Portal:Toolforge
 Resolved• srodlundT211646 Update and Improve: https://wikitech.wikimedia.org/wiki/Help:Toolforge/FAQ
 Resolved• srodlundT211722 Create Toolforge Policy landing page
 Resolved• srodlundT211725 Create more thorough and visible navbox for Toolforge Help documentation
 Resolved• srodlundT230437 Update Wikitech Sidebar
 Resolved• srodlundT230438 Create Toolforge Troubleshooting page
 Resolved• srodlundT232398 Create About Page for Cloud VPS
 Resolved• srodlundT232399 Improve https://wikitech.wikimedia.org/wiki/Help:Cloud_VPS
 Resolved• srodlundT232402 Add appropriate Categories to Toolforge and Cloud VPS Technical Documentation
 Resolved• srodlundT232408 Create a comprehensive overview of documentation page for WMCS
 Resolved• srodlundT232409 Toolforge and Cloud VPS Technical Documentation Survey
 Resolved• srodlundT233367 Restructure and improve content for: https://wikitech.wikimedia.org/wiki/Help:Instances
 Resolved• srodlundT239517 Change the namespace of Cloud VPS documentation pages
 Resolved• srodlundT240630 Create technical documentation checklist and templates for Cloud VPS and Toolforge
 OpenNoneT245083 Improve content design of: https://wikitech.wikimedia.org/wiki/Help:MediaWiki-Vagrant_in_Cloud_VPS
 ResolvedAklapperT245297 Update and Improve https://wikitech.wikimedia.org/wiki/Help:Standalone_puppetmaster
 OpenNoneT245314 Update and improve: https://wikitech.wikimedia.org/wiki/Help:Toolforge/Java
 DuplicateNoneT245685 Improve content design of: https://wikitech.wikimedia.org/wiki/Help:Toolforge/My_first_Pywikibot_tool
 OpenNoneT126094 Create a "Beginners guide to creating a Cloud VPS instance" wiki page

Event Timeline

• srodlund created this task.Aug 29 2018, 11:14 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptAug 29 2018, 11:14 PM
• srodlund edited projects, added Toolforge; removed Cloud-Services.Aug 29 2018, 11:15 PM
• srodlund updated the task description. (Show Details)Aug 29 2018, 11:21 PM
• srodlund added a project: User-srodlund.Sep 7 2018, 8:25 PM
• srodlund moved this task from Backlog to New Documentation on the User-srodlund board.Sep 11 2018, 6:31 PM
• srodlund moved this task from New Documentation to Processes and goals on the User-srodlund board.Sep 11 2018, 7:32 PM
• srodlund added a subtask: T211643: Update and Improve: https://wikitech.wikimedia.org/wiki/Portal:Toolforge/Admin .Dec 11 2018, 12:21 AM
• srodlund updated the task description. (Show Details)Dec 12 2018, 6:58 PM
• srodlund renamed this task from Update and Improve ToolForge Technical Documentation to Update and Improve ToolForge and Cloud VPS TechnicalDocumentation.Sep 9 2019, 9:57 PM
• srodlund updated the task description. (Show Details)
• srodlund closed subtask T211646: Update and Improve: https://wikitech.wikimedia.org/wiki/Help:Toolforge/FAQ as Resolved.
• srodlund closed subtask T204132: Update and Improve: https://wikitech.wikimedia.org/wiki/Portal:Toolforge as Resolved.Sep 9 2019, 10:01 PM
• srodlund renamed this task from Update and Improve ToolForge and Cloud VPS TechnicalDocumentation to Update and Improve ToolForge and Cloud VPS Technical Documentation.Sep 9 2019, 10:11 PM
zhuyifei1999 added a subscriber: zhuyifei1999.Sep 17 2019, 9:40 PM
• srodlund closed subtask T230438: Create Toolforge Troubleshooting page as Resolved.Sep 25 2019, 4:19 PM
• srodlund mentioned this in T234634: Wikimedia Technical Conference 2019 Session: On-wiki documentation & documentation as code: strengths, weaknesses, and compromises.Oct 17 2019, 3:41 PM
Pavithraes added a subscriber: Pavithraes.Oct 22 2019, 5:43 AM
• srodlund closed subtask T211725: Create more thorough and visible navbox for Toolforge Help documentation as Resolved.Dec 4 2019, 11:27 PM
• srodlund closed subtask T230437: Update Wikitech Sidebar as Resolved.
• srodlund closed subtask T211722: Create Toolforge Policy landing page as Resolved.Dec 9 2019, 6:47 PM
• srodlund closed subtask T233367: Restructure and improve content for: https://wikitech.wikimedia.org/wiki/Help:Instances as Resolved.Dec 9 2019, 7:19 PM
xSavitar added a subscriber: xSavitar.Feb 25 2020, 6:11 PM
xSavitar updated the task description. (Show Details)Feb 25 2020, 6:16 PM
DannyS712 reopened subtask T204130: Update and Improve https://wikitech.wikimedia.org/wiki/Help:Toolforge as Open.Mar 5 2020, 11:22 PM
• srodlund closed subtask T232398: Create About Page for Cloud VPS as Resolved.May 11 2020, 8:35 PM
• srodlund closed subtask T232399: Improve https://wikitech.wikimedia.org/wiki/Help:Cloud_VPS as Resolved.May 11 2020, 8:42 PM
• srodlund closed subtask T204130: Update and Improve https://wikitech.wikimedia.org/wiki/Help:Toolforge as Resolved.
• srodlund closed subtask T232402: Add appropriate Categories to Toolforge and Cloud VPS Technical Documentation as Resolved.May 11 2020, 8:51 PM
• srodlund closed subtask T239517: Change the namespace of Cloud VPS documentation pages as Resolved.May 11 2020, 8:56 PM
• srodlund closed subtask T240630: Create technical documentation checklist and templates for Cloud VPS and Toolforge as Resolved.May 11 2020, 9:01 PM
Gbahdeyboh mentioned this in T255360: GSoD 2020 Proposal: Improving Wikimedia's onboarding processes and documentation standards.Jun 14 2020, 4:28 AM
• srodlund removed • srodlund as the assignee of this task.Jun 25 2020, 8:22 PM
• srodlund closed subtask T232408: Create a comprehensive overview of documentation page for WMCS as Resolved.Jun 25 2020, 9:05 PM
• srodlund closed subtask T232409: Toolforge and Cloud VPS Technical Documentation Survey as Resolved.Jan 7 2021, 6:03 PM
TBurmeister added a subscriber: TBurmeister.Oct 13 2021, 9:22 PM
Aklapper closed subtask T245297: Update and Improve https://wikitech.wikimedia.org/wiki/Help:Standalone_puppetmaster as Resolved.Mar 22 2022, 12:57 PM
Krinkle renamed this task from Update and Improve ToolForge and Cloud VPS Technical Documentation to Update and Improve Toolforge and Cloud VPS Technical Documentation.Apr 22 2022, 9:34 PM
Jcash0464 added a subscriber: Jcash0464.Jan 24 2023, 9:13 AM
TBurmeister changed the task status from Open to In Progress.Jul 17 2023, 7:57 PM
TBurmeister claimed this task.
TBurmeister triaged this task as Medium priority.

I have claimed this task because some (but not all) of the work it describes will overlap with my work on T327319. I will also claim any subtasks that I intend to work on as part of that project, and file additional ones as needed for the doc work the project has identified.

TBurmeister closed subtask T230440: Update Toolforge and Cloud VPS Help pages as Declined.Jul 17 2023, 8:01 PM
TBurmeister removed a subtask: T230440: Update Toolforge and Cloud VPS Help pages.
TBurmeister merged a task: T230440: Update Toolforge and Cloud VPS Help pages.Jul 17 2023, 8:03 PM
TBurmeister added a subscriber: Quiddity.
TBurmeister removed a subtask: T211643: Update and Improve: https://wikitech.wikimedia.org/wiki/Portal:Toolforge/Admin .Jul 17 2023, 8:12 PM
TBurmeister changed the status of subtask T211729: Update and improve: https://wikitech.wikimedia.org/wiki/Help:Toolforge/How_to from Open to In Progress.Aug 21 2023, 6:14 PM
TBurmeister removed a subtask: T211729: Update and improve: https://wikitech.wikimedia.org/wiki/Help:Toolforge/How_to.Aug 21 2023, 6:23 PM
TBurmeister added a subtask: T126094: Create a "Beginners guide to creating a Cloud VPS instance" wiki page.Aug 21 2023, 6:31 PM
Content licensed under Creative Commons Attribution-ShareAlike 4.0 (CC-BY-SA) unless otherwise noted; code licensed under GNU General Public License (GPL) or 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