Forums / Suggestions / Better release notes

Better release notes

Author Message

Paul Forsyth

Thursday 28 August 2003 1:03:51 am

Could the release notes for version (betas, rcs, final) be rewritten to describe better what has changed between versions?

I forgot to mention this at the conference but it would be great if we didn't have a massive list of changes that has come direct from svn commits.

I would like to see an overview for individual sections that have changed discussing what is new and what bugs have been fixed (urls,ids preferrably). For example, the current kernel change list needs to be split up into affect parts of the kernel.

Also it would be nice if known issues are published for that version, issues you may have found during testing but have workarounds that you recommend.

The changelog should still be there but referenced in some way from each section.

This information will really help people looking to migrate between versions. As ez 3 becomes more stable and ez 4 starts to be thought about users need better information about changes between versions.

Paul

Jan Borsodi

Thursday 28 August 2003 4:03:02 am

You mean like a compact summary of important changes?

Should this be a part of the release (like Changelogs) or as a document on ez.no?

--
Amos

Documentation: http://ez.no/ez_publish/documentation
FAQ: http://ez.no/ez_publish/documentation/faq

Paul Forsyth

Thursday 28 August 2003 4:34:58 am

Most software releases provide the same document with the release as they have on their website, whether it is as a .txt or a .html file, so one version should be fine.

Yes a summary of important changes to each area would be nice. For example, the 3.2 beta release has *many* changes to the kernel which may affect developers working with the 3.1 sdk, translations, so speaking about the big changes there, api's and so on would be lovely. At the very least it should be able to tell developers that they should look at what changes have occured. A big all-in-one list obscures the changes.

Of course, you need to balance what users will be interested in low level changes :) I would like to see good high level summaries with discussion of changes within modules, libs and kernels areas and the apis used to communicate between each.

The svn list currently has some seperation between areas. If this was augmented with further information along the above lines that would be great.

Paul

Paul Forsyth

Thursday 04 September 2003 1:27:32 am

Thanks for the 3.2 beta 2 release documentation. I really like the new format! Though I have a couple of gripes, wishes... :)

Could the level of detail be improved to state which areas are affected by updates. I notice a few obscure mentions of sdk changes. Could these be specifially assigned to an area, and maybe expanded upon? Most of the changes seem to be for users but i know sdk changes have been occurring.

Do you have a list of known issues with a release that you have found through your testing phase? Could the larger issues be posted as part of a release?

As Paul B mentions in his comment to the beta2 release the svn log was handy... Im not sure if it is good to include the full changelog as before in the same document. Maybe there should be a seperate document listing the changelogs for all releases... I've seen this used on other projects.

Paul

eZ debug

Timing: Jan 18 2025 04:21:33
Script start
Timing: Jan 18 2025 04:21:33
Module start 'content'
Timing: Jan 18 2025 04:21:33
Module end 'content'
Timing: Jan 18 2025 04:21:33
Script end

Main resources:

Total runtime0.2850 sec
Peak memory usage2,048.0000 KB
Database Queries141

Timing points:

CheckpointStart (sec)Duration (sec)Memory at start (KB)Memory used (KB)
Script start 0.00000.0108 588.8047180.8438
Module start 'content' 0.01080.0055 769.648497.7422
Module end 'content' 0.01640.2686 867.3906528.5547
Script end 0.2850  1,395.9453 

Time accumulators:

 Accumulator Duration (sec) Duration (%) Count Average (sec)
Ini load
Load cache0.00391.3671200.0002
Check MTime0.00150.5252200.0001
Mysql Total
Database connection0.00190.658910.0019
Mysqli_queries0.233882.03921410.0017
Looping result0.00190.66701390.0000
Template Total0.268094.010.2680
Template load0.00100.348410.0010
Template processing0.267093.673910.2670
Override
Cache load0.00070.238910.0007
Sytem overhead
Fetch class attribute can translate value0.00090.301710.0009
XML
Image XML parsing0.00020.071910.0002
General
dbfile0.00160.5579200.0001
String conversion0.00000.002830.0000
Note: percentages do not add up to 100% because some accumulators overlap

CSS/JS files loaded with "ezjscPacker" during request:

CacheTypePacklevelSourceFiles
CSS0extension/community/design/community/stylesheets/ext/jquery.autocomplete.css
extension/community_design/design/suncana/stylesheets/scrollbars.css
extension/community_design/design/suncana/stylesheets/tabs.css
extension/community_design/design/suncana/stylesheets/roadmap.css
extension/community_design/design/suncana/stylesheets/content.css
extension/community_design/design/suncana/stylesheets/star-rating.css
extension/community_design/design/suncana/stylesheets/syntax_and_custom_tags.css
extension/community_design/design/suncana/stylesheets/buttons.css
extension/community_design/design/suncana/stylesheets/tweetbox.css
extension/community_design/design/suncana/stylesheets/jquery.fancybox-1.3.4.css
extension/bcsmoothgallery/design/standard/stylesheets/magnific-popup.css
extension/sevenx/design/simple/stylesheets/star_rating.css
extension/sevenx/design/simple/stylesheets/libs/fontawesome/css/all.min.css
extension/sevenx/design/simple/stylesheets/main.v02.css
extension/sevenx/design/simple/stylesheets/main.v02.res.css
JS0extension/ezjscore/design/standard/lib/yui/3.17.2/build/yui/yui-min.js
extension/ezjscore/design/standard/javascript/jquery-3.7.0.min.js
extension/community_design/design/suncana/javascript/jquery.ui.core.min.js
extension/community_design/design/suncana/javascript/jquery.ui.widget.min.js
extension/community_design/design/suncana/javascript/jquery.easing.1.3.js
extension/community_design/design/suncana/javascript/jquery.ui.tabs.js
extension/community_design/design/suncana/javascript/jquery.hoverIntent.min.js
extension/community_design/design/suncana/javascript/jquery.popmenu.js
extension/community_design/design/suncana/javascript/jScrollPane.js
extension/community_design/design/suncana/javascript/jquery.mousewheel.js
extension/community_design/design/suncana/javascript/jquery.cycle.all.js
extension/sevenx/design/simple/javascript/jquery.scrollTo.js
extension/community_design/design/suncana/javascript/jquery.cookie.js
extension/community_design/design/suncana/javascript/ezstarrating_jquery.js
extension/community_design/design/suncana/javascript/jquery.initboxes.js
extension/community_design/design/suncana/javascript/app.js
extension/community_design/design/suncana/javascript/twitterwidget.js
extension/community_design/design/suncana/javascript/community.js
extension/community_design/design/suncana/javascript/roadmap.js
extension/community_design/design/suncana/javascript/ez.js
extension/community_design/design/suncana/javascript/ezshareevents.js
extension/sevenx/design/simple/javascript/main.js

Templates used to render the page:

UsageRequested templateTemplateTemplate loadedEditOverride
1pagelayout.tpl<No override>extension/sevenx/design/simple/templates/pagelayout.tplEdit templateOverride template
 Number of times templates used: 1
 Number of unique templates used: 1

Time used to render debug report: 0.0001 secs