[PP-1] In comments, quote the names of the phases of Package Manager's stage lifecycle

Created on 30 September 2024, about 2 months ago

Problem/Motivation

Blocked on ✨ Add Alpha level Experimental Package Manager module Needs review .

In her review, @quietone had the following feedback: https://git.drupalcode.org/project/drupal/-/merge_requests/3608#note_339226

It is a request to quote certain key words used by Package Manager, like "active", "stage", "require", "destroy", etc., when discussing the stage life cycle in comments.

Since these words are used all over the damn place in Package Manager, it was decided to do this in a follow-up. That's this issue!

πŸ“Œ Task
Status

Postponed

Version

11.0 πŸ”₯

Component

other

Created by

πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @phenaproxima
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    I should note, for the record, that I do not agree with doing this. I think that quoting these words is, essentially, an awkward workaround for the fact that Package Manager introduces a tremendous amount of new jargon, much of which was not well thought-out at all (me and @tedbow invented it all whole-cloth, so I'll take my share of responsibility for that). IMHO, all that quotes will do is italicize the added cognitive load for anyone who is trying to grok Package Manager by reading the comments.

    My preferred approach would be, instead, to rethink the wording that we use so that it is clearer and dovetails with existing concepts and metaphors.

    For example:

    "active directory" --> "live site"
    "stage" (noun) --> "sandbox"

    This won't work in every situation, of course, and in some cases I agree that quoting will be the clearest thing we could do. But in general, I'd rather rethink the wording than merely quote everything and call it a day.

  • πŸ‡¬πŸ‡§United Kingdom catch

    Should we postpone this on πŸ“Œ Clarify/replace 'stage' terminology in Package Manager Active (i.e. PP-2)?

Production build 0.71.5 2024