Re: [josm-dev] Creating a user-friendly changelog for tested release
On Tue, Feb 7, 2012 at 8:23 AM, Simon Legner simon.leg...@gmail.com wrote: Hi, On 30/01/12 15:07, Josh Doe wrote: I would suggest that we create a single set of changes between each tested release, separating the changes by major/minor enhancements, and major bugs (leaving minor bugs to be found via tickets). I believe this would be more helpful for users rather than seeing a long list of major changes (but missing some minor ones), without any visual demarcation telling them what has changed from the version they're using to the last tested. I like this idea as it provides more insight to JOSM development for casual users. Furthermore, I always like to read a list of new features of any product. For this reason, I've created a wiki page: http://josm.openstreetmap.de/wiki/Changelog For the most recent stable release, I went through the commit messages and put together a list of (in my opinion) interesting changes. Note that the classification is subjective, and feel free to add/remove/move any item. I've created a similar page for plugins, as their changes have very little visibility aside from the massive (in scope) OSM SVN log: http://josm.openstreetmap.de/wiki/Plugin%20changelog I organized by month since there's (currently) no concept of tested released for plugins; if there are better ideas please let us know. Help to expand this is greatly appreciated. -Josh ___ josm-dev mailing list josm-dev@openstreetmap.org http://lists.openstreetmap.org/listinfo/josm-dev
Re: [josm-dev] Creating a user-friendly changelog for tested release
On Sat, 11 Feb 2012, Simon Legner wrote: Do you think we can merge both lists, at least internally? We'd have one wiki page ChangelogSource and each entry is marked either for changelog or for startup note or for both. This would remove redundancy and make live easier for the translators. Removing duplication is a good idea. However, in my opinion, this only makes sense if the changelog messages are translated to a decent number of languages. Is it common to translate the changelog of a software to several languages? I think the common parts between these two aren't large enough to try to think about joining them. Concerning a ChangelogSource, I don't know whether this is possible from a technical point of view as I'm not familiar with the internals of Trac. A negative aspect (in my opinion) of StartupPageSource is that This is not trac, but JOSM Trac. ChangelogSource could be setup similar to VersionHistory or StartupPage. the translation strings somehow clutters the text which makes it harder to just quickly find a news item or edit the wiki page. This translation system was designed to translate the single-line startup screen. Especially the fact that translated and untranslated strings are mixed in final page was important for this. The drawback is that layout is broken into multiple pieces. Today we have a second system with the language specific pages and the Diff-display showing differences to last translation. I basically developed this to improve translation update process (which works, as translations are updated a lot better than before) and now maintain the relevant Trac plugin. But for the StartupPage I still think the existing line-based system fits better. For Changelog I don't see a big need for translations, so I would think the page based translation system fits better for this one. What I would like to do is to display the translation diff in the edit screen of a translated page, but I was not yet able to do so. Ciao -- http://www.dstoecker.eu/ (PGP key available) ___ josm-dev mailing list josm-dev@openstreetmap.org http://lists.openstreetmap.org/listinfo/josm-dev
Re: [josm-dev] Creating a user-friendly changelog for tested release
Hi! On 09/02/12 16:58, Paul Hartmann wrote: Do you think we can merge both lists, at least internally? We'd have one wiki page ChangelogSource and each entry is marked either for changelog or for startup note or for both. This would remove redundancy and make live easier for the translators. Removing duplication is a good idea. However, in my opinion, this only makes sense if the changelog messages are translated to a decent number of languages. Is it common to translate the changelog of a software to several languages? Concerning a ChangelogSource, I don't know whether this is possible from a technical point of view as I'm not familiar with the internals of Trac. A negative aspect (in my opinion) of StartupPageSource is that the translation strings somehow clutters the text which makes it harder to just quickly find a news item or edit the wiki page. Just my two cents ... Simon ___ josm-dev mailing list josm-dev@openstreetmap.org http://lists.openstreetmap.org/listinfo/josm-dev
Re: [josm-dev] Creating a user-friendly changelog for tested release
On 02/07/2012 02:23 PM, Simon Legner wrote: Hi, On 30/01/12 15:07, Josh Doe wrote: I would suggest that we create a single set of changes between each tested release, separating the changes by major/minor enhancements, and major bugs (leaving minor bugs to be found via tickets). I believe this would be more helpful for users rather than seeing a long list of major changes (but missing some minor ones), without any visual demarcation telling them what has changed from the version they're using to the last tested. I like this idea as it provides more insight to JOSM development for casual users. Furthermore, I always like to read a list of new features of any product. For this reason, I've created a wiki page: http://josm.openstreetmap.de/wiki/Changelog For the most recent stable release, I went through the commit messages and put together a list of (in my opinion) interesting changes. Note that the classification is subjective, and feel free to add/remove/move any item. For the startup notes, I try to mention only those changes, that could be interesting for the normal user and provide at least a little documentation. Your new changelog seems to be more from the developer's point of view, which is also interesting. It's a good idea to make a paragraph for each tested version, I could imagine this for the the startup notes as well. Do you think we can merge both lists, at least internally? We'd have one wiki page ChangelogSource and each entry is marked either for changelog or for startup note or for both. This would remove redundancy and make live easier for the translators. Paul ___ josm-dev mailing list josm-dev@openstreetmap.org http://lists.openstreetmap.org/listinfo/josm-dev
Re: [josm-dev] Creating a user-friendly changelog for tested release
On Mon, 30 Jan 2012, Josh Doe wrote: I think it would be useful to create a more user-friendly changelog for the -tested releases, something which lies between the contents of the StartupPage and the SVN log. As we seem to be focused on creating a better experience for new users (e.g. creating expert mode), I think we need to take the same approach to the changelog. I would suggest that we create a single set of changes between each tested release, separating the changes by major/minor enhancements, and major bugs (leaving minor bugs to be found via tickets). I believe this would be more helpful for users rather than seeing a long list of major changes (but missing some minor ones), without any visual demarcation telling them what has changed from the version they're using to the last tested. Has this been discussed or thought about before? I know it would take some thought to avoid duplication of text (especially translated strings). If you are volunteering to do, you're welcome to create a wiki page and fill it with contents. Very likely you wont get a lot of help. I wouldn't expect translations for this page. Ciao -- http://www.dstoecker.eu/ (PGP key available) ___ josm-dev mailing list josm-dev@openstreetmap.org http://lists.openstreetmap.org/listinfo/josm-dev
