Updated: Comment #N

Problem/Motivation

The issue queue used to use the two different tags for classifying issues "Needs change notice" and "Needs change notification" until it was cleaned up (issue). "Needs change notification" was chosen because it was used in the majority of cases. Yet, issues that need a record change start with "Change notice: ..."

The documentation Contributor task: Write up a change record for a Drupal core issue uses both "change record" and "change notification" terms in its alias, title and content.

The list of 'change records' for Drupal core is at https://drupal.org/list-changes (note the alias) and the content type is 'changenotice'.

I find notification a bit odd: we're not sending notifications in this context, we not notifying in the sense "inform (someone) of something, typically in a formal or official manner.". Notice or record sounds more appropriate. I could go with notice since it's used so much in the issue titles.

Proposed resolution

Standardize on "Change record":

  • Rename the term "Needs change notification" (link) to "Needs change notice".
  • Update the documentation Contributor task: Write up a change record for a Drupal core issue which uses both "change record" and "change notification" terms in its title and content.
  • Change alias https://drupal.org/contributor-tasks/draft-change-notification to https://drupal.org/contributor-tasks/draft-change-notice and set up a redirect from the old to the new URL (this might not be necessary if this option is already be enabled in the pathauto settings)
  • On https://drupal.org/node/add the human-readable content type name there is "Change record"
  • On https://drupal.org/list-changes the page title is "Change records" and the link there says "add new change record"
  • On the sidebar of https://drupal.org/project/drupal down at the bottom there's a link that says "change records"
  • On issue page sidebar, update link to add change record

Remaining tasks

execute changes above

User interface changes

API changes

Issue fork drupalorg-2155653

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

scor’s picture

scor commented
Issue summary: View changes
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Project: Drupal core » [Archive] Drupal.org D7 upgrade QA
Version: 8.x-dev »
Component: documentation » User interface

This is not a Drupal Core issue, but a d.o issue... and it's not really a D7 QA issue but I do not know where generic "d.o" issues are supposed to be filed these days. At least in this queue the people who maintain d.o will see it.

tvn’s picture

tvn commented
Project: [Archive] Drupal.org D7 upgrade QA » Drupal.org customizations
Version: » 7.x-3.x-dev

Oh my, this was annoying me for such a long time! Finally it's not me only.

Change record content type and a view are included in the 'Change notices' feature, which is a part of Drupal.org customizations module.

Anyone interested can request a dev site following https://drupal.org/node/1018084, update content type/view and re-create the feature. Then upload the feature to this issue.

Changing machine name of the content type (if desired) will probably require hook_update or something.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Changing the machine name of the node type -- ugh, let's not attempt that. I also don't think at this point we want to change the URLs.

However, we should make everything else as uniform as possible.

What should we standardize on?

dww’s picture

dww
we/he/they
commented

I vote to use "change notice" everywhere user-facing. I don't care as much about machine names used internally, although the more of those we can be consistent about, too, the better.

scor’s picture

scor commented

I'm also fine with 'change notice', at least we won't have to change the content type machine name which would be a pain.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

OK, so let's agree to change everything to use the term "change notice", but leave any existing URL aliases and machine names alone.

The issue summary doesn't really say what all needs to be updated. Can someone research and make a list?

scor’s picture

scor commented
Issue summary: View changes

updating summary to list the proposed changes, the content type is already named correctly so no need to change anything there.

scor’s picture

scor commented
Issue summary: View changes
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Ah, OK, that looks easy to do.

However, you forgot:
https://drupal.org/node/add/
The human-readable content type name there is "Change record", so that also needs to be updated, right?

And on
https://drupal.org/list-changes
the page title is "Change records" and the link there says "add new change record", so that should also say "change notices", right?

And on the sidebar of
https://drupal.org/project/drupal
down at the bottom there's a link that says "change records" too.

So... I don't think the summary is complete yet.

dww’s picture

dww
we/he/they
commented
Issue summary: View changes

Added jhodgon's suggestions and converted the proposed resolution section to <ul>. We can just <del> each item as we implement this.

If anyone else sees other inconsistencies anywhere on d.o, please add them to the list in the summary instead of just leaving a comment. ;)

Thanks,
-Derek

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Thanks, and sorry for being lazy. :(

tvn’s picture

tvn commented
Issue tags: +drupal.org hitlist
scor’s picture

scor commented

Since I last updated this issue summary, looks like at least the 3 first items have been modified to standardize on "change record" even though there seemed to be a consensus on using "change notice". Again, I personally don't mind which one gets picked in the end. Anyone knows who made those changes? would be good to ping that person so he/she is aware of this conversation, and whatever final decision is made here.

xjm’s picture

xjm
she/her
Primary language English
commented

I'm not sure where there was a consensus to use "change notice"; we agreed to standardize on "change record" eight months ago during the overhaul of the feature. So that is what we should use everywhere, including in text comments in the issue queue. So the issue summary needs an update.

tvn’s picture

tvn commented

I guess people meant consensus reached in this issue, which also happened 8 months ago. Can you link to the issue/discussion you are referring to?

scor’s picture

scor commented

yes, when I meant consensus I was only talking about this issue.

I don't really care what terminology gets picked, only for its usage to be consistent...

shyamala’s picture

shyamala commented
Issue tags: -drupal.org hitlist +drupal.org hitlist

editing tags

drumm’s picture

drumm
he/him
Location NY, US
commented
Issue summary: View changes
Issue tags: +Needs issue summary update

Standardize on change record instead of notice, according to #2550857-12: Add way of creating changenotice from issue page

sokru made their first commit to this issue’s fork.

sokru opened merge request !284

sokru’s picture

sokru commented
Issue summary: View changes
Status: Active » Needs review
Issue tags: -Needs issue summary update

I went through the remaining tasks and all but last issue was not done. I created a MR for remaining task.

  • drumm committed 913712f7 on 7.x-3.x authored by sokru 
    Issue #2155653: Change "add change notice" to "add change record" on...
drumm’s picture

drumm
he/him
Location NY, US
commented
Status: Needs review » Fixed

Thanks, deployed!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.