Page MenuHomePhabricator

Update and Improve ToolForge and Cloud VPS Technical Documentation
Open, Needs TriagePublic

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 VPStechnical 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

StatusAssignedTask
Opensrodlund
Opensrodlund
Resolvedsrodlund
Resolvedsrodlund
Opensrodlund
Opensrodlund
Opensrodlund
Opensrodlund
Opensrodlund
Opensrodlund
Opensrodlund
Opensrodlund
Opensrodlund
Opensrodlund
Opensrodlund
Opensrodlund
Opensrodlund
Opensrodlund
Opensrodlund
Duplicatesrodlund
Opensrodlund
Opensrodlund
Opensrodlund
Opensrodlund
Opensrodlund
Opensrodlund

Event Timeline

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 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.Mon, Sep 9, 9:57 PM
srodlund updated the task description. (Show Details)
srodlund renamed this task from Update and Improve ToolForge and Cloud VPS TechnicalDocumentation to Update and Improve ToolForge and Cloud VPS Technical Documentation.Mon, Sep 9, 10:11 PM