[meta] Improve change records

Created on 25 June 2014, over 10 years ago
Updated 15 April 2024, 8 months ago

There are a lot of ways in which our change record functionality falls short of meeting our needs or resolving the problem it was intended to resolve, especially since we now have over 800 (!) of them for Drupal core. These issues range from people not being able to find the change records they need, to an enormous documentation debt that comes with ensuring 800 change records are current, etc.

This is a meta issue to track Drupal.org issues, Drupal core policy issues, and any contrib/scaffolding tool issues that will help address this for the Drupal 8 change records specifically.

πŸ“Œ Task
Status

Active

Version

11.0 πŸ”₯

Component
DocumentationΒ  β†’

Last updated 1 day ago

No maintainer
Created by

πŸ‡ΊπŸ‡ΈUnited States xjm

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

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • πŸ‡©πŸ‡°Denmark ressa Copenhagen

    Thanks for going through the list of unpublished Change Records and publishing the fixed ones @quietone.

    Can "Publish the Change record" get included in a checklist in the documentation for Change Records?

    Alternatively, it could be included in the issue template?

    <h3 id="summary-problem-motivation">Problem/Motivation</h3>
    
    
    <h4 id="summary-steps-reproduce">Steps to reproduce</h4>
    
    
    <h3 id="summary-proposed-resolution">Proposed resolution</h3>
    
    
    <h3 id="summary-remaining-tasks">Remaining tasks</h3>
    
    
    <h3 id="summary-ui-changes">User interface changes</h3>
    
    
    <h3 id="summary-api-changes">API changes</h3>
    
    
    <h3 id="summary-data-model-changes">Data model changes</h3>
    
    
    <h3 id="summary-release-notes">Release notes snippet</h3>
    
    
    <h3 id="summary-change-record">Change Record</h3> <<<<<<<<< ADD THIS?
    <ul>
      <li>Create Change Record draft</li>
      <li>Publish Change Record</li>
    </ul>
    

    The items can then get marked up with strike-through, when done:

    Change Record

    • Publish Change Record
Production build 0.71.5 2024