search

ConsumerDataStandardsAustralia / standards-staging

Other
1 stars 0 forks source link

Merge Change Log and Archives sections #413

Closed nils-work closed 1 day ago

nils-work commented 3 months ago

The Standards Change Log and Archives sections contain tables of mostly repeated information with different links to their respective detail. These tables could be merged to simplify and improve the user experience and reduce maintenance.

As the Change Log generally contains more detail, the proposal is to retain it and add the current and archived version links to the Version column. Where there is a mismatch in detail, the fields will be corrected and merged if necessary. The Archives section could then be removed once all detail is collated into a single table.

Change proposed

  1. Change the Change Log heading to Change log and archives.
  2. Change the introductory text to:

    The following table lists the changes made to these standards in reverse date order (most recent change and current version is at the top). Archived versions are prior versions of the standards that are available for reference only and not considered binding.

  3. Transfer the respective version links from the Archives table (currently applied to the Release Date and Description fields) to the Version column in the Change log and archives table.
  4. Two rows in the Archives table ('November 2018 Working Draft' and 'Christmas 2018 Working Draft - InfoSec Profile') are not present in the current Change Log and these should be inserted into the updated table in the appropriate sequence.
  5. There are currently minor differences between the Change Date and Release Date values for some versions. Where there is a conflict, the date from the Change Log will be retained.
  6. Change the Change Date column name to just Date.
  7. Where there is a difference between the two sets of Description values (~11 versions prior to 2022), the Archives text will be appended to the Change Log text for completeness.

For reference

Current Change Log: image

Current Archives: image

Proposed combined Change log and archives: image

nils-work commented 2 months ago

Changes staged here including renaming the section to Changelog and archives

nils-work commented 1 day ago

Incorporated into Standards v1.32.0