Page MenuHomePhabricator

Technical / Peer Review of https://wikitech.wikimedia.org/wiki/Help:Instances
Open, NormalPublic

Description

https://wikitech.wikimedia.org/wiki/Help:Instances has been majorly revised and will require a technical review to ensure the information is correct and comprehensive (AKA. Is anything missing?)

  • Correct any technical inaccuracies
  • Add any missing information
  • Set a "next review" date
  • Make sure any pages that link to the now obsolete Help:Instance Lifecycle Page are updated.
  • Make sure links to sections of this page from other pages on Wikitech are fixed

Event Timeline

srodlund updated the task description. (Show Details)Wed, Oct 23, 11:39 PM

A comment on this section:

Why create an Cloud VPS instance?

Cloud VPS is a flexible option for those who need it. It is equivalent to having your own server(s).

Before requesting a Cloud VPS instance, we recommend you consider using Toolforge instead of. Toolforge has many of the same features as Cloud VPS, and Toolforge users do not have to manage the full virtual environment. Toolforge users can apply Puppet roles to instances via the Horizon WebUI; Toolforge users also have access to toolsdb, wiki replicas, and a number of other services.

See Cloud VPS vs Toolforge to help decide which service is right for you.

The statement Toolforge users can apply Puppet roles to instances via the Horizon WebUI seems inaccurate. Toolforge users can't do that, that is for Cloud VPS users.
Also, I'm not sure if the statement is trying to highlight a benefit for Toolforge or Cloud VPS (or a flaw?).

In any case, having to deal with puppet roles for instances is a feature of Cloud VPS, that requires certain knowledge and (more than basic?) system administration skills.

Hope this comment help clarify that section.

Other comment:

I see project admin, Project Admin, projectadmin and project administrator used across the document. Perhaps this can be further homogenized.

Comment:

The Instance information section contains a table of different options for creating a VM. This probably refers to this panel:

It seems the wiki page lacks metion of the 'Source' option, in which users can decide the version of the Operating System (Debian Stretch, Debian Buster, etc), also known as base image.

@aborrero Thank you for this! I will integrate changes to the page asap.

RE: Project Admin vs projectadmin vs project admin. I believe this is inconsistent here and throughout the documentation.

Even the official glossary has two spellings: https://wikitech.wikimedia.org/wiki/Help:Glossary#Kinds_of_users

We may want to decide on one global name/definition and make changes throughout the Cloud VPS documentation. For now I'm going to use "Project admin" to be consistent with the other admin roles defined here :https://wikitech.wikimedia.org/wiki/Help:Access#Project_Admins

We may want to decide on one global name/definition and make changes throughout the Cloud VPS documentation. For now I'm going to use "Project admin" to be consistent with the other admin roles defined here :https://wikitech.wikimedia.org/wiki/Help:Access#Project_Admins

+1. Pick the words that feel like they will be easiest for folks to understand as canonical.

@aborrero These changes are now in place.

great work! thanks!

aborrero triaged this task as Normal priority.Fri, Nov 22, 10:15 AM