www.digitalmars.com         C & C++   DMDScript  

digitalmars.D - split up the changelog?

reply "anonymous" <anonymous example.com> writes:
The changelog.html file is at about 1MB. That makes for a 
noticeable load time. And with all the issue lists, it's also a 
pretty solid wall of text: "Wait, is all this still for 2.067.0? 
Did I miss a version heading? I think I'm lost."

Let's split it up by version!

Pull request:
https://github.com/D-Programming-Language/dlang.org/pull/1006

Preview:
http://d-ag0aep6g.rhcloud.com/changelog/index.html

I think these are the typical use cases for the changelog:

1) Looking up the changes in the latest or some particular 
version: This benefits from a shorter load time and no more 
unrelated content.

2) Finding the version which made a particular change: This can't 
be done with Ctrl+F anymore, as Vladimir Panteleev (CyberShadow) 
mentions in the PR discussion. He also gives the alternative: 
google with "site:dlang.org/changelog". Good enough?

3) Reading through language history: This becomes more pleasant 
with a split changelog, as you don't have to scroll over pages of 
bugzilla issues anymore to get to the good stuff: prose and code 
samples.

Opinions?
Jun 19 2015
next sibling parent David Gileadi <gileadis NSPMgmail.com> writes:
On 6/19/15 8:59 AM, anonymous wrote:
 The changelog.html file is at about 1MB. That makes for a noticeable
 load time. And with all the issue lists, it's also a pretty solid wall
 of text: "Wait, is all this still for 2.067.0? Did I miss a version
 heading? I think I'm lost."

 Let's split it up by version!

 Pull request:
 https://github.com/D-Programming-Language/dlang.org/pull/1006

 Preview:
 http://d-ag0aep6g.rhcloud.com/changelog/index.html

 I think these are the typical use cases for the changelog:

 1) Looking up the changes in the latest or some particular version: This
 benefits from a shorter load time and no more unrelated content.

 2) Finding the version which made a particular change: This can't be
 done with Ctrl+F anymore, as Vladimir Panteleev (CyberShadow) mentions
 in the PR discussion. He also gives the alternative: google with
 "site:dlang.org/changelog". Good enough?

 3) Reading through language history: This becomes more pleasant with a
 split changelog, as you don't have to scroll over pages of bugzilla
 issues anymore to get to the good stuff: prose and code samples.

 Opinions?
I like it! My only suggestion is that perhaps the landing page should be the changelog for the latest version, since most of the time I'm interested in what the latest changes are.
Jun 19 2015
prev sibling parent reply Nick Sabalausky <SeeWebsiteToContactMe semitwist.com> writes:
On 06/19/2015 11:59 AM, anonymous wrote:
 Let's split it up by version!

 Preview:
 http://d-ag0aep6g.rhcloud.com/changelog/index.html
Yes, please.
Jun 19 2015
parent reply Andrei Alexandrescu <SeeWebsiteForEmail erdani.org> writes:
On 6/19/15 9:38 AM, Nick Sabalausky wrote:
 On 06/19/2015 11:59 AM, anonymous wrote:
 Let's split it up by version!

 Preview:
 http://d-ag0aep6g.rhcloud.com/changelog/index.html
Yes, please.
I think the current version's changelog should be visible, and the list of previous releases goes at the bottom. -- Andrei
Jun 19 2015
next sibling parent reply "tcak" <tcak gmail.com> writes:
On Friday, 19 June 2015 at 17:00:41 UTC, Andrei Alexandrescu 
wrote:
 On 6/19/15 9:38 AM, Nick Sabalausky wrote:
 On 06/19/2015 11:59 AM, anonymous wrote:
 Let's split it up by version!

 Preview:
 http://d-ag0aep6g.rhcloud.com/changelog/index.html
Yes, please.
I think the current version's changelog should be visible, and the list of previous releases goes at the bottom. -- Andrei
I like this style best. https://developer.mozilla.org/en-US/Firefox/Releases/38 But D's changelog gives more information which is better IMO.
Jun 19 2015
parent Nick Sabalausky <SeeWebsiteToContactMe semitwist.com> writes:
On 06/19/2015 02:05 PM, tcak wrote:
 On Friday, 19 June 2015 at 17:00:41 UTC, Andrei Alexandrescu wrote:
 On 6/19/15 9:38 AM, Nick Sabalausky wrote:
 On 06/19/2015 11:59 AM, anonymous wrote:
 Let's split it up by version!

 Preview:
 http://d-ag0aep6g.rhcloud.com/changelog/index.html
Yes, please.
I think the current version's changelog should be visible, and the list of previous releases goes at the bottom. -- Andrei
I like this style best. https://developer.mozilla.org/en-US/Firefox/Releases/38 But D's changelog gives more information which is better IMO.
Personally, I find that cluttered, messy and horizontally cramped. And it's too hard to find the list of previous versions hidden allllll the way down at the bottom.
Jun 19 2015
prev sibling parent reply Steven Schveighoffer <schveiguy yahoo.com> writes:
On 6/19/15 1:00 PM, Andrei Alexandrescu wrote:
 On 6/19/15 9:38 AM, Nick Sabalausky wrote:
 On 06/19/2015 11:59 AM, anonymous wrote:
 Let's split it up by version!

 Preview:
 http://d-ag0aep6g.rhcloud.com/changelog/index.html
Yes, please.
I think the current version's changelog should be visible, and the list of previous releases goes at the bottom. -- Andrei
BTW, one annoyance of mine is that there is no easy way to find another version besides the current version. If you search for e.g. "2.065", you will get 41 matches, and all the ones before the one you want are due to regressions that identify the version where the regression occurred. I liked the old changelog layout where you have the first revision, then a list of links to older revisions, and then everything else. Having the newest revision and then everything else linked is a good idea to save on bandwidth. But, what about making the changelog menu an accordion expander, and then you have your version list right there on the left? -Steve
Jun 19 2015
next sibling parent David Gileadi <gileadis NSPMgmail.com> writes:
On 6/19/15 12:22 PM, Steven Schveighoffer wrote:
 But, what about making the changelog menu an accordion expander, and
 then you have your version list right there on the left?
I really like that idea. The left nav is supposed to be an index to things, after all.
Jun 19 2015
prev sibling parent reply "anonymous" <anonymous example.com> writes:
On Friday, 19 June 2015 at 19:22:03 UTC, Steven Schveighoffer 
wrote:
 But, what about making the changelog menu an accordion 
 expander, and then you have your version list right there on 
 the left?
Did that here: http://d-ag0aep6g.rhcloud.com/accordion/changelog/2.067.1.html I like it. I kept the previous/next version links at the top for now, but I'm not sure how useful they are. For some reason the list stops at 2.023. I don't know if I messed something up, or if dmd is being silly. Will have to investigate. Another thing I'd like to get to work are legacy URLs like e.g. <http://dlang.org/changelog.html#2.067.0> and <http://dlang.org/changelog.html#new2_064>. In the other version I set it up to redirect and jump to an entry in the list on changelog/index.html. But adding all those IDs to the accordion links doesn't feel right, and I'm not sure if it can work correctly. I'd rather make another list page whose sole purpose is legacy URL support. But so far I couldn't figure out a nice way to share code with the accordion list. Will have to investigate, too.
Jun 19 2015
next sibling parent Steven Schveighoffer <schveiguy yahoo.com> writes:
On 6/19/15 5:28 PM, anonymous wrote:
 On Friday, 19 June 2015 at 19:22:03 UTC, Steven Schveighoffer wrote:
 But, what about making the changelog menu an accordion expander, and
 then you have your version list right there on the left?
Did that here: http://d-ag0aep6g.rhcloud.com/accordion/changelog/2.067.1.html I like it.
Me too :) Looks perfect.
 I kept the previous/next version links at the top for now, but I'm not
 sure how useful they are.
I think they are useful.
 Another thing I'd like to get to work are legacy URLs like e.g.
 <http://dlang.org/changelog.html#2.067.0> and
 <http://dlang.org/changelog.html#new2_064>. In the other version I set
 it up to redirect and jump to an entry in the list on
 changelog/index.html. But adding all those IDs to the accordion links
 doesn't feel right, and I'm not sure if it can work correctly. I'd
 rather make another list page whose sole purpose is legacy URL support.
 But so far I couldn't figure out a nice way to share code with the
 accordion list. Will have to investigate, too.
Hm... not sure how many people would have used those, since you have to click on the "Version" anchor to get to that link. -Steve
Jun 19 2015
prev sibling parent "anonymous" <anonymous example.com> writes:
On Friday, 19 June 2015 at 21:28:11 UTC, anonymous wrote:
 For some reason the list stops at 2.023. I don't know if I 
 messed something up, or if dmd is being silly. Will have to 
 investigate.
Filed issue 14717 - Ddoc macro recursion limit too low: https://issues.dlang.org/show_bug.cgi?id=14717
 Another thing I'd like to get to work are legacy URLs like e.g.
 <http://dlang.org/changelog.html#2.067.0> and
 <http://dlang.org/changelog.html#new2_064>.
Solved this to my satisfaction by redirecting to a legacy.html which is not going to be updated further.
Jun 20 2015