Page MenuHomePhabricator

Consolidate information about tool memory, resources, and quota into one doc
Open, Needs TriagePublic

Description

As a Toolforge user or prospective user, I want to be able to quickly understand the memory and resources available to me for running my tool(s). I want to know how to monitor my tools' memory and resource usage, how and when to request a quota increase, and things I should consider before doing that.

  1. Content in the following sections should be consolidated into one new document:
  1. Once a new doc is created for all the above content, pieces of it that are relevant to web services or jobs framework can be transcluded into those pages, or the pages can link to the new resources doc. Only include the minimum amount of information necessary -- one goal of this work is to reduce how many times this information is duplicated across the docs.
  1. The new doc should include a section that outlines the Quota Increase request process and the considerations that may cause a Toolforge user to request to use Trove.
  1. When this new doc is created, it should be linked from the following docs, replacing the current links about the topic:

Event Timeline

https://wikitech.wikimedia.org/wiki/Help:Toolforge/Kubernetes#Quotas_and_Resources is marked for moving to a new doc and I would like to understand where @TBurmeister or others in the tech writing role feel it should be listed. The quotas are Kubernetes specific and shared across the Web and Job Service consumers along with any other direct k8s usage that a tool may choose to pursue for itself. To me it makes sense to keep that use case crossing information in a central location that is also directly related to the platform it is documenting, meaning in this case the Kubernetes page.

The new document I suggested creating when I filed this would be a how-to page focused on the task of managing tool quota and resources. For example, a new page entitled "Manage tool quota and resources". Right now, this content being in a k8s-specific document requires users to understand what k8s is and get familiar with it in order to be able to find the information. It also requires visiting many different docs to try to understand how to work with tool quota -- the information is not all covered in the k8s section on quota. The conceptual structure of the docs should be focused first on the user's task, then on the technologies that support that task, rather than vice versa -- because the underlying technologies change over time, but the users' tasks are generally the same. It's also easier to get things done when the information related to one task is in one document, rather than mixed with other content in a document focusing on a larger topic like k8s instead of a task-focused topic like "how to manage your tool's resources".