Page MenuHomePhabricator

Revise: About_Toolforge
Closed, ResolvedPublic

Description

Current page:
https://wikitech.wikimedia.org/wiki/Portal:Toolforge/About_Toolforge

Draft revision:
https://wikitech.wikimedia.org/wiki/User:Triciaburmeister/Sandbox/About_Toolforge

TODO:

  • Resolve TODOs via interviews with SMEs
  • Layout and visual design improvements
  • Tech writer peer review
  • SME / WMCS team member review
  • Copyediting
  • Replace current page with new revision
  • Update incoming anchor links where feasible

Event Timeline

TBurmeister changed the task status from Open to In Progress.Aug 21 2023, 4:38 PM
TBurmeister triaged this task as Medium priority.
TBurmeister created this task.
TBurmeister moved this task from Backlog to In progress on the Tech-Docs-Team board.
TBurmeister added a subscriber: fnegri.

Assigning to @fnegri for subject expertise! Suggested tasks to help develop this doc:

  • Consider how you would describe to a new developer the overall workflow of using Toolforge, whether they're going to build a webservice or a bot or something else. What are the common, major stages of the setup and development workflow that every user will have to go through? You can create a diagram if it would be useful, or you can write words or use bulleted lists...whatever works!
  • Consider the key concepts you think a new user must understand as they learn to use Toolforge. What are the fundamental building blocks of the mental model that users should have for how Toolforge works? For example: bastion hosts, tool accounts. The Cloud glossary may be useful (though incomplete) input for this exercise.
  • After you've written down your thoughts for those two items, take a look at this diagram I've created. Take note of how and where our models diverge, and consider what you might change to make a workflow diagram like this useful to beginners.

I'll schedule time for us to discuss next week. Thanks!

The comments on this Talk page may provide some additional useful insight into the high-level concepts that users find confusing or missing in our current documentation: https://wikitech.wikimedia.org/wiki/Help_talk:Toolforge/Quickstart#Critics_to_this_Quickstart_guide:

I navigated and read a lot of wiki pages and subpages about Toolforge, Kubernets, Toolforge/Web, Python (because I want to create Python-based tool), Version control, Gerrit, etc. And, as a result, all those peaces of information I read are now messed up in my head and I still don't know what to do to launch my first service, and what does that "webservice start" command do, and how is this Kubernets and Bastion are related to my new webservice, and what is a place that I get into, when I do SSH at "tools-login.toolforge.org" or "tools-dev.toolforge.org". And what is a difference between "tools-dev" and "tools-login" (this Q arises when you're reading Help:Access to Toolforge instances with PuTTY and WinSCP). And why " manage files in Toolforge" link tells how to "take ownership"? In my new service there's no files at all. And why have to do "become <tool>"? This "Quickstart" guide is fine, I passed all 6 steps, but what is next?

This user's comment indicates both: a need for improved tutorials / how-to guides (which is covered by other phabricator tasks), and a need to understand the general concepts of how Toolforge works, to clear up confusion about how Kubernetes and Bastion relate to their webservice, how file management works, what ownership means in the context of tool accounts, etc. etc. That is the focus of this task.

I'm going to reassign this to myself while I work on creating a rough draft based on your initial doc, and an overview diagram based on our conversation. I'll assign back to you for feedback and review!

@fnegri Here is a final draft for you to review, please feel free to edit whatever you want!

Note to self: after this is published, replace link here with one to the section about bastion hosts:

Log in to Toolforge

  1. Use your SSH client to connect to Toolforge through a [[Help:Terminology#Bastion host|bastion host]]. <-- replace this link

Nice work! I made a few small edits. I also noticed a few places with "Note: ..." where it might be nice to use a callout template.

I finally checked the final draft, sorry for the wait. I think it looks really good, I made only a small edit to the Database section

TBurmeister updated the task description. (Show Details)
TBurmeister awarded a token.