Opened 8 years ago

Closed 8 years ago

#1820 closed enhancement (fixed)

Use a table to display changelog data

Reported by: drewapicture's profile DrewAPicture Owned by:
Milestone: Priority: normal
Component: Developer Hub Keywords: has-patch has-screenshots

Description (last modified by DrewAPicture)

Changelog information is by nature tabular data, so we should probably be displaying it as such instead of as an un-ordered list. This change also makes the structure more predictable and improves readability and focusability for screen reader and keyboard users.

And it's looks nice too :-)

Note for the attached patch: Ended up needing to use a <caption> tag for the table to ensure a11y compliance instead of adding an id attribute to the <h3> – it was messing with the ToC's ability to render the section correctly.

Attachments (3)

1820.diff (1.6 KB) - added by DrewAPicture 8 years ago.
1820_before.png (40.9 KB) - added by DrewAPicture 8 years ago.
Before 1820.diff
1820_after.png (43.1 KB) - added by DrewAPicture 8 years ago.
w/ 1820.diff

Download all attachments as: .zip

Change History (9)

8 years ago

#1 @DrewAPicture
8 years ago

  • Description modified (diff)

#2 @ocean90
8 years ago

+💯 for using a table. sorts the changelog from newest to oldest. Not sure if we should do the same.

#3 @kevinwhoffman
8 years ago

+1 newest to oldest. As a developer I'm usually looking at a changelog because I want to know what changed in the most recent version.

#4 @DrewAPicture
8 years ago

I'm -1 on reversing the order. It's worth noting that our docs standard dictates oldest-to-newest in DocBlocks and they're therefore stored in that order when parsing. Doing an array_reverse() is trivial, but I'd kind of like to keep it consistently ordered in both places.

#5 @drewapicture
8 years ago

In 3668: Display changelog data in a table, ordered newest-to-oldest.

See #1819. See #1820.

#6 @DrewAPicture
8 years ago

  • Resolution set to fixed
  • Status changed from new to closed

Stylesheet bumped in [3669]. Closing as fixed.

Note: See TracTickets for help on using tickets.