split up the changelog #1006

aG0aep6G · 2015-06-02T10:59:11Z

The per-version changelog files (changelog/2.foo.dd) have been extracted from the full log by this little ugly script: https://gist.github.com/aG0aep6G/014339e25fd39ae638f1.

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

CyberShadow · 2015-06-15T22:58:51Z

I think we discussed splitting the changelog once before... the main disadvantage is that it breaks Ctrl+F to search all versions' changelogs. But now that it's in its own directory, we could do Google "site:dlang.org/changelog" searches.

I'm not against the idea but it's a non-trivial change and should be approved by more people.

aG0aep6G · 2015-06-19T16:01:33Z

Made a thread on the forum: http://forum.dlang.org/post/thvnxyvvtqjrutzdugtf@forum.dlang.org

aG0aep6G · 2015-06-20T23:23:38Z

Moved the list to the site menu, as suggested by Steven Schveighoffer in the forum discussion. Unfortunately, issue 14717 makes it fall short. That will have to be fixed first.

Legacy URLs like changelog.html#2.067.0 now redirect to changelog/legacy.html which is not going to be updated with new versions.

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

aG0aep6G · 2015-07-04T21:08:40Z

Unfortunately, issue 14717 makes it fall short.

PR to fix issue 14717: dlang/dmd#4799

andralex · 2015-07-07T20:03:04Z

please rebase

aG0aep6G · 2015-07-08T18:03:42Z

.htaccess

@@ -23,3 +23,5 @@ Redirect 301 /dll.html http://wiki.dlang.org/Win32_DLLs_in_D
 Redirect 301 /htomodule.html http://wiki.dlang.org/Converting_C_.h_Files_to_D_Modules
 Redirect 301 /memory.html http://wiki.dlang.org/Memory_Management
 Redirect 301 /windows.html http://wiki.dlang.org/D_for_Win32
+
+RewriteRule ^changelog.html$ changelog/legacy.html [R=301,L]


Should this be Redirect? I'm not that well-versed in Apache configuration.

We can use either. But we'll need to test if the ^ will work as expected, IIRC there were some issues with RewriteBase.

aG0aep6G · 2015-07-08T18:05:31Z

Rebased. Preview is at http://d-ag0aep6g.rhcloud.com again.

Issue 14717 has been fixed, so this is good to go from my side.

MartinNowak · 2015-08-08T11:36:10Z

I like it. The changelog page is too big, takes ages to compile, and ages to load.
We could also add some js to legacy.html to directly redirect #2.067.0 to the 2.067.0 page?

MartinNowak · 2015-08-08T11:37:55Z

What about other anchors on the page? I just recently cleaned up the version anchors to be 2.067.0, there is still some legacy anchor new2067 or so.

aG0aep6G · 2015-08-08T14:34:08Z

I like it. The changelog page is too big, takes ages to compile, and ages to load.
We could also add some js to legacy.html to directly redirect #2.067.0 to the 2.067.0 page?

I guess that's possible. Will look into it.

What about other anchors on the page? I just recently cleaned up the version anchors to be 2.067.0, there is still some legacy anchor new2067 or so.

legacy.html has both kinds of anchors. I.e. these two take you to the same link:
http://d-ag0aep6g.rhcloud.com/changelog.html#2.067.1
http://d-ag0aep6g.rhcloud.com/changelog.html#new2_067.1

aG0aep6G · 2015-08-08T16:05:30Z

Did the JS redirects. My JS-foo isn't that great, so someone should look over it.

http://d-ag0aep6g.rhcloud.com/changelog.html#2.067.1 and
http://d-ag0aep6g.rhcloud.com/changelog.html#new2_067.1 should take you to
http://d-ag0aep6g.rhcloud.com/changelog/2.067.1.html now.

aG0aep6G · 2015-08-12T14:53:40Z

Updated for 2.068. I'd appreciate if we could get this over with.

aG0aep6G · 2015-08-20T12:02:20Z

Ping? This has been sitting idle for more than a week now. It's still good to go from my side.

CyberShadow · 2015-08-20T12:40:20Z

This link currently works (unfortunately):

http://dlang.org/changelog

aG0aep6G · 2015-08-20T13:10:59Z

This link currently works (unfortunately):

http://dlang.org/changelog

Redirecting that one to changelog/legacy.html too now. I.e., these work:
http://d-ag0aep6g.rhcloud.com/changelog (-> /changelog/legacy.html)
http://d-ag0aep6g.rhcloud.com/changelog#2.068.0 (-> /changelog/legacy.html#2.068.0 -> /changelog/2.068.0.html)

CyberShadow · 2015-08-20T13:15:18Z

http://dtest.thecybershadow.net/artifact/website-bb011af464e0c6aac7fcff1d65dc61ed499f2b82-06e16d9f514ddd1641dd267af85ea145/web/changelog/2.068.0.html

This is completely broken because it still thinks that css and js files are under css/ and js/, they are now at ../css/ and ../js/

CyberShadow · 2015-08-20T13:17:29Z

I'm not sure we need the entire changelog index in the sidebar. Instead, I suggest...

An index page
At the top and bottom of each version's changelog, links to the next and previous versions' changelogs, and to the index

CyberShadow · 2015-08-20T13:18:02Z

Apart from being unstyled, the per-version changelog pages appear to be all devoid of actual change logs.

aG0aep6G · 2015-08-20T13:44:23Z

This is completely broken because it still thinks that css and js files are under css/ and js/, they are now at ../css/ and ../js/

Apart from being unstyled, the per-version changelog pages appear to be all devoid of actual change logs.

I don't know what's going on here. When I build it, those problems don't come up.

I'm not sure we need the entire changelog index in the sidebar. Instead, I suggest...

An index page
At the top and bottom of each version's changelog, links to the next and previous versions' changelogs, and to the index

This started with something similar to that. The current layout was a suggestion from Steven Schveighoffer which people seemed to like (at least no one spoke up against it).

Also, I don't see what a dedicated index page would buy us over having all versions in the sidebar. Having them in the sidebar, highlighting of the current page works trivially, and it acts as a "you are here" indicator in the changelog history.

aG0aep6G · 2015-08-20T14:02:02Z

I don't know what's going on here. When I build it, those problems don't come up.

There's no mention of changelog.ddoc in the build log. A missing changelog.ddoc would explain the issues, I think. No idea why it's not there, though.

CyberShadow · 2015-08-20T14:05:42Z

make is probably picking up this rule:

$(DOC_OUTPUT_DIR)/%.html : %.dd $(DDOC) $(DMD)
    $(DMD) -conf= -c -o- -Df$@ $(DDOC) $<

before this one:

$(DOC_OUTPUT_DIR)/changelog/%.html : changelog/%.dd $(CHANGELOG_DDOC) $(DMD)
    $(DMD) -conf= -c -o- -Df$@ $(CHANGELOG_DDOC) $<

aG0aep6G · 2015-08-20T14:13:01Z

Yup, swapped them around, and it seems to work now. Is it ok to rely on the order like this?

CyberShadow · 2015-08-20T14:26:34Z

This started with something similar to that. The current layout was a suggestion from Steven Schveighoffer which people seemed to like (at least no one spoke up against it).

Also, I don't see what a dedicated index page would buy us over having all versions in the sidebar. Having them in the sidebar, highlighting of the current page works trivially, and it acts as a "you are here" indicator in the changelog history.

I don't know, I don't think I agree with that. Having miles-long navigation is just poor UI. You shouldn't have to scroll the page to navigate around a website. The list is only going to get longer, as well. Do you know any other websites that do this?

I think the sidebar should only list the latest few versions. Everything else's significance is mostly historical, and shouldn't be there any more than 1.x and 0.x changelogs should.

aG0aep6G · 2015-08-20T15:48:21Z

You shouldn't have to scroll the page to navigate around a website. The list is only going to get longer, as well. Do you know any other websites that do this?

The section can be collapsed, and "D reference" and "Books & Articles" force scrolling, too. But it's true that the changelog section is already longer than those and will only get even longer.

I think the sidebar should only list the latest few versions. Everything else's significance is mostly historical, and shouldn't be there any more than 1.x and 0.x changelogs should.

I wouldn't mind changing it back to a single item (or a few items) in the sidebar and a dedicated listing page. People didn't seem to like it, though. However, I think the main point was that the landing page of the changelog should be the latest entry rather than the listing, which should be doable.

That would mean: clicking "Change Log" in the sidebar takes you to changelog/2.068.0.html where you have "previous/next version" and "all versions" which takes you to a long list of links to all the changelog entries. Would everyone be happy with that? @andralex @schveiguy

schveiguy · 2015-08-20T15:55:04Z

Would everyone be happy with that?

If there is a way to get to a prior version (any prior version) aside from actually scrolling the page down to that version via visual scan (current model), then I'm fine with it. A list of versions with clickable links to each version is a must somewhere, I don't care where, and I don't care how it works (either anchors or individual pages). Putting it on the sidebar, or making it its own page, whatever works for everyone else is fine with me with those requirements satisfied.

Found by doing grep -o -P "(href|src)=(\"[^\"]+\"|'[^']+')" web/changelog/*.html | grep -P -v "(href|src)=(\"|')\s*(https?://|irc://|\.\.|2\.\d\d\d(\.\d)?\.html|list\.html|#)"

aG0aep6G · 2015-08-21T14:11:31Z

That would mean: clicking "Change Log" in the sidebar takes you to changelog/2.068.0.html where you have "previous/next version" and "all versions" which takes you to a long list of links to all the changelog entries. Would everyone be happy with that? @andralex @schveiguy

Did that.

CyberShadow · 2015-08-21T14:16:49Z

Looks nice. @andralex ?

schveiguy · 2015-08-21T14:25:01Z

LGTM

MartinNowak · 2015-08-22T07:49:49Z

clicking "Change Log" in the sidebar takes you to changelog/2.068.0.html where you have "previous/next version" and "all versions" which takes you to a long list of links to all the changelog entries.

Much nicer than the long menu.

MartinNowak · 2015-08-22T07:58:09Z

Thanks for the very good work.

split up the changelog

CyberShadow · 2015-08-23T00:05:17Z

Well done and thanks for persevering, @aG0aep6G.

aG0aep6G force-pushed the split-changelog branch 2 times, most recently from 153921c to 35fd7b8 Compare June 2, 2015 11:16

aG0aep6G force-pushed the split-changelog branch from dc40ff6 to 260a069 Compare June 15, 2015 20:21

aG0aep6G force-pushed the split-changelog branch 2 times, most recently from be4fe27 to 06e7035 Compare June 19, 2015 14:48

aG0aep6G force-pushed the split-changelog branch from 1a52673 to edab3c1 Compare June 20, 2015 23:14

aG0aep6G force-pushed the split-changelog branch from edab3c1 to d82fac0 Compare July 8, 2015 18:01

aG0aep6G reviewed Jul 8, 2015
View reviewed changes

aG0aep6G force-pushed the split-changelog branch from bb5fd4c to 676bce8 Compare August 12, 2015 14:51

aG0aep6G force-pushed the split-changelog branch 3 times, most recently from c62a6a2 to 6ddac3c Compare August 19, 2015 13:07

DDoc: remove wrong closing parenthesis

1197364

aG0aep6G force-pushed the split-changelog branch from a1f7369 to af1b6fe Compare August 21, 2015 11:48

aG0aep6G added 3 commits August 21, 2015 16:02

split up the changelog

2f2f1d9

update links to the changelog

4def69b

update links from the changelog

ccfe4f4

Found by doing grep -o -P "(href|src)=(\"[^\"]+\"|'[^']+')" web/changelog/*.html | grep -P -v "(href|src)=(\"|')\s*(https?://|irc://|\.\.|2\.\d\d\d(\.\d)?\.html|list\.html|#)"

aG0aep6G force-pushed the split-changelog branch from af1b6fe to ccfe4f4 Compare August 21, 2015 14:07

MartinNowak added a commit that referenced this pull request Aug 22, 2015

Merge pull request #1006 from aG0aep6G/split-changelog

8e10e3d

split up the changelog

MartinNowak merged commit 8e10e3d into dlang:master Aug 22, 2015

aG0aep6G deleted the split-changelog branch August 23, 2015 21:31

Uh oh!

split up the changelog #1006

split up the changelog #1006

Uh oh!

Conversation

aG0aep6G commented Jun 2, 2015

Uh oh!

CyberShadow commented Jun 15, 2015

Uh oh!

aG0aep6G commented Jun 19, 2015

Uh oh!

aG0aep6G commented Jun 20, 2015

Uh oh!

aG0aep6G commented Jul 4, 2015

Uh oh!

andralex commented Jul 7, 2015

Uh oh!

aG0aep6G Jul 8, 2015

Choose a reason for hiding this comment

Uh oh!

CyberShadow Jul 8, 2015

Choose a reason for hiding this comment

Uh oh!

aG0aep6G commented Jul 8, 2015

Uh oh!

MartinNowak commented Aug 8, 2015

Uh oh!

MartinNowak commented Aug 8, 2015

Uh oh!

aG0aep6G commented Aug 8, 2015

Uh oh!

aG0aep6G commented Aug 8, 2015

Uh oh!

aG0aep6G commented Aug 12, 2015

Uh oh!

aG0aep6G commented Aug 20, 2015

Uh oh!

CyberShadow commented Aug 20, 2015

Uh oh!

aG0aep6G commented Aug 20, 2015

Uh oh!

CyberShadow commented Aug 20, 2015

Uh oh!

CyberShadow commented Aug 20, 2015

Uh oh!

CyberShadow commented Aug 20, 2015

Uh oh!

aG0aep6G commented Aug 20, 2015

Uh oh!

aG0aep6G commented Aug 20, 2015

Uh oh!

CyberShadow commented Aug 20, 2015

Uh oh!

aG0aep6G commented Aug 20, 2015

Uh oh!

CyberShadow commented Aug 20, 2015

Uh oh!

aG0aep6G commented Aug 20, 2015

Uh oh!

schveiguy commented Aug 20, 2015

Uh oh!

aG0aep6G commented Aug 21, 2015

Uh oh!

CyberShadow commented Aug 21, 2015

Uh oh!

schveiguy commented Aug 21, 2015

Uh oh!

MartinNowak commented Aug 22, 2015

Uh oh!

MartinNowak commented Aug 22, 2015

Uh oh!

CyberShadow commented Aug 23, 2015

Uh oh!

Uh oh!