-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refresh the design of the 'Changelogs' pages #7479
Changes from all commits
90f03c1
ce68942
a5b3c8b
a271829
301006a
da3c388
152bbc4
683bf00
e3c7d69
76b0582
2ce1df0
f31ae88
e10ed4e
209ab96
45f3af5
54096fc
c806a1f
77bd626
552a1ad
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,42 @@ | ||
--- | ||
layout: changelog | ||
show_ratings: true | ||
has_rss: false | ||
layout: simplepage | ||
title: Changelog | ||
notitle: true | ||
tight: true | ||
backlink: | ||
label: Back to changelogs | ||
url: ../ | ||
--- | ||
|
||
= partial('release-header.html.haml', :release => page.release) | ||
-if page.release.changes and page.release.lts_changes and page.release.lts_baseline | ||
%div | ||
%strong | ||
-# TODO figure out how to get rid of this | ||
= "Changes since #{page.release.lts_baseline}:" | ||
%ul.image | ||
= partial('release-header.html.haml', :release => page.release, :entry => true) | ||
|
||
- if page.type == 'stable' | ||
%a{:class => "app-button app-button--primary app-releases__upgrade-guide", :href => "/doc/upgrade-guide/" + page.release.version.rpartition('.').first + "#upgrading-to-jenkins-lts-" + page.release.version.to_s.tr_s(".", "-")} | ||
%ion-icon{:name => "arrow-up-circle-outline"} | ||
.app-releases__upgrade-guide__title | ||
Looking to upgrade? | ||
.app-releases__upgrade-guide__description | ||
= "Check the Upgrade Guide for assistance" | ||
|
||
#head | ||
%script{:src => "/files/rate.js", :type => "text/javascript"} | ||
|
||
:javascript | ||
$(document).ready(function() { | ||
loaddata(this); | ||
}); | ||
|
||
- if page.release.changes and page.release.lts_changes and page.release.lts_baseline | ||
.app-releases__notable-changes | ||
-# TODO figure out how to get rid of this | ||
= "Changes since #{page.release.lts_baseline}" | ||
|
||
%div.app-releases__list__items | ||
= partial('changelog-changes.html.haml', :changes => page.release.changes) | ||
-if page.release.changes and page.release.lts_changes | ||
%div | ||
%strong | ||
= "Notable changes since #{page.release.lts_predecessor}:" | ||
%ul.image | ||
|
||
- if page.release.changes and page.release.lts_changes | ||
.app-releases__notable-changes | ||
= "Notable changes since #{page.release.lts_predecessor}" | ||
|
||
%div.app-releases__list__items | ||
= partial('changelog-changes.html.haml', :changes => page.release.lts_changes) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,42 @@ | ||
:ruby | ||
tags = { | ||
'security' => 'Security', | ||
'rfe' => 'Enhancement', | ||
'majorrfe' => 'Major enhancement', | ||
'bug' => 'Bug fix', | ||
'majorbug' => 'Major bug fix' | ||
} | ||
|
||
- if page.changes.empty? | ||
%em | ||
No notable changes in this release. | ||
- page.changes.each do | change | | ||
%li{:class => change.type } | ||
= change.message | ||
- if change.references | ||
- change.references.each_with_index do | reference, index | | ||
- if index == 0 | ||
( | ||
- else | ||
, | ||
- if reference.issue | ||
%a{:href => "https://issues.jenkins.io/browse/JENKINS-#{reference.issue}" }<> | ||
= "issue #{reference.issue}" | ||
- if reference.pull | ||
%a{:href => "https://github.com/jenkinsci/jenkins/pull/#{reference.pull}" }<> | ||
= "pull #{reference.pull}" | ||
- else | ||
%a{:href => reference.url }<> | ||
- if reference.title | ||
= reference.title | ||
- else | ||
= reference.url | ||
- if index == change.references.count - 1 | ||
) | ||
- elsif change.issue | ||
( | ||
%a{:href => "https://issues.jenkins.io/browse/JENKINS-#{change.issue}" }<> | ||
= "issue #{change.issue}" | ||
) | ||
- elsif change.pull | ||
( | ||
%a{:href => "https://github.com/jenkinsci/jenkins/pull/#{change.pull}" }<> | ||
= "pull #{change.pull}" | ||
) | ||
- page.changes.group_by { |message| message["type"] }.each do | type, logs | | ||
%div{:class => 'app-releases__tag app-releases__tag--' + type.gsub(' ', '')} | ||
= tags[type.gsub(' ', '')] | ||
%ul.app-releases__list{:class => 'app-releases__list--' + type.gsub(' ', '')} | ||
- logs.each do | change | | ||
%li | ||
= change.message | ||
%span.app-releases__references | ||
- if change.references | ||
- change.references.each_with_index do | reference, index | | ||
- if index != 0 | ||
, | ||
- if reference.issue | ||
%a{:href => "https://issues.jenkins.io/browse/JENKINS-#{reference.issue}" }<> | ||
= "issue #{reference.issue}" | ||
- if reference.pull | ||
%a{:href => "https://github.com/jenkinsci/jenkins/pull/#{reference.pull}" }<> | ||
= "pull #{reference.pull}" | ||
- else | ||
%a{:href => reference.url }<> | ||
- if reference.title | ||
= reference.title | ||
- else | ||
= reference.url | ||
- elsif change.issue | ||
%a{:href => "https://issues.jenkins.io/browse/JENKINS-#{change.issue}" }<> | ||
= "issue #{change.issue}" | ||
- elsif change.pull | ||
%a{:href => "https://github.com/jenkinsci/jenkins/pull/#{change.pull}" }<> | ||
= "pull #{change.pull}" |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,16 @@ | ||
%h3{:id => "v#{page.release.version}" } | ||
= "What's new in #{page.release.version}" | ||
- if page.release.date | ||
= "(#{page.release.date})" | ||
%div.app-releases__list__header | ||
%div | ||
- if page.entry | ||
%h1{:id => "v#{page.release.version}", :class => 'app-releases__item__title', :'data-type' => 'release-header', :'data-version' => page.release.version} | ||
= 'Changelog for ' + page.release.version | ||
- else | ||
%h3{:id => "v#{page.release.version}", :class => 'app-releases__item__title', :'data-type' => 'release-header', :'data-version' => page.release.version} | ||
%a{:href => "/#{page.url}/#{page.release.version}/"} | ||
= page.release.version | ||
- if page.release.date | ||
%div{:class => 'app-releases__item__date'} | ||
= page.release.date.strftime('%B %-d, %Y') | ||
|
||
- if page.release.banner | ||
%div{:class => 'app-banner'} | ||
= page.release.banner | ||
= page.release.banner |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -3,40 +3,30 @@ layout: changelog | |||||
title: LTS Changelog | ||||||
show_ratings: true | ||||||
has_rss: true | ||||||
actions: | ||||||
<a class="app-button app-button--primary app-mobile-hide" href="/doc/upgrade-guide"> | ||||||
<ion-icon name="arrow-up-circle-outline"></ion-icon> | ||||||
Upgrade Guide | ||||||
</a> | ||||||
--- | ||||||
|
||||||
%div{:class => 'app-banner'} | ||||||
See the | ||||||
%a{:href => '/doc/upgrade-guide/'} | ||||||
LTS upgrade guide | ||||||
for advice on upgrading Jenkins. | ||||||
|
||||||
%div{:class => 'app-banner'} | ||||||
See the | ||||||
%a{:href => '/download/lts'} | ||||||
LTS Release Line | ||||||
for more information on Jenkins LTS. | ||||||
|
||||||
.ratings | ||||||
- # source: https://github.com/jenkins-infra/jenkins.io/blob/master/content/_data/changelogs/lts.yml | ||||||
- site.changelogs[:lts].reverse_each do | release | | ||||||
- if Gem::Version.new(release.version) <= Gem::Version.new(site.jenkins.stable) | ||||||
= partial('release-header.html.haml', :release => release) | ||||||
%p | ||||||
%small | ||||||
%a{:href => "/changelog-stable/#{release.version}/" } | ||||||
permalink to this entry | ||||||
-if release.changes and release.lts_changes and release.lts_baseline | ||||||
%div | ||||||
%strong | ||||||
%div | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
That's from the HTML archive, when we didn't use YAML yet:
I think this difference is acceptable and we don't need to rewrite ancient HTML for the new format. It seems that all we're losing with this PR is the old changelog votes for 2.19.4 and earlier, that seems OK. (For weekly changelog, we didn't have votes in changelog-old already anyway.) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we need to keep displaying it on the page or could we archive it? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think we should delete changelogs, but if we do, we should start with historical weekly changelogs. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Weekly only displays x number already, The oldest one is: (29 weeks) Not saying delete them, we could have an archive page for older than a reasonable period. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Makes sense, I read your suggestion as completely removing. I'd keep at least 2 years of changelogs around though for LTS. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Created an issue to track: #7502 |
||||||
= partial('release-header.html.haml', :release => release, :url => 'changelog-stable') | ||||||
- if release.changes and release.lts_changes and release.lts_baseline | ||||||
.app-releases__notable-changes{:style => "margin-top: 15px"} | ||||||
-# TODO figure out how to get rid of this | ||||||
= "Changes since #{release.lts_baseline}:" | ||||||
%ul.image | ||||||
= partial('changelog-changes.html.haml', :changes => release.changes) | ||||||
-if release.changes and release.lts_changes | ||||||
%div | ||||||
%strong | ||||||
= "Notable changes since #{release.lts_predecessor}:" | ||||||
%ul.image | ||||||
= partial('changelog-changes.html.haml', :changes => release.lts_changes) | ||||||
= "Changes since #{release.lts_baseline}" | ||||||
%div.app-releases__list__items | ||||||
= partial('changelog-changes.html.haml', :changes => release.changes) | ||||||
|
||||||
- if release.changes and release.lts_changes | ||||||
.app-releases__notable-changes | ||||||
= "Notable changes since #{release.lts_predecessor}" | ||||||
%div.app-releases__list__items | ||||||
= partial('changelog-changes.html.haml', :changes => release.lts_changes) | ||||||
Comment on lines
+26
to
+30
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not indented far enough, so https://www.jenkins.io/changelog-stable/ currently has "Notable changes" for an unreleased version of Jenkins. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||||||
|
||||||
= partial('changelog-stable.html') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would recommend that at least the same grouping be done for the RSS/Atom changelog feed. I do not expect changelog authors to regularly look at that, so will likely miss if the experience there deteriorates (less grouping of entries in the data file).