Improving the LiveCode release notes

Monte Goulding monte at appisle.net
Mon Dec 14 20:00:31 EST 2015


Hi Peter

I’m not sure if you’ve seen this report of mine or if your review of the release notes includes a review of server notes or is desktop only.

http://quality.livecode.com/show_bug.cgi?id=16350 <http://quality.livecode.com/show_bug.cgi?id=16350>

Basically I think the above could be resolved and things simplified in general if the installation guide is a separate file. Maybe even a separate file per platform.

A loong time ago I had fun with git on a rainy weekend and came up with a web app that was intended to be a github/bitbucket service hook. Here’s what it pumped out:

http://ecove.on-rev.com/mergext.com/notes.html <http://ecove.on-rev.com/mergext.com/notes.html>

Actually it’s markdown files that are pumped out and the above page is rentered by flatdoc http://ricostacruz.com/flatdoc/

I even registered git-v.info but I never got around to deploying it after realising the server resources required could blow out quite rapidly. I’ve still got the code though it probably needs some extra work to handle the multiple notes directories and multiple development branches that the repo now has. The basic idea was that people could see exactly which version a change was made in and link to the commit and bug report and also see what is upcoming on a release branch and on the development frontier. 

Anyway, I’m positive you know how to get the notes out of git in the same way I did here I just thought you might be interested to see the format and how live updates to the notes via a service hook could be used to let people know what’s on the way etc.

Cheers

Monte

> On 15 Dec 2015, at 4:46 am, Peter TB Brett <peter.brett at livecode.com> wrote:
> 
> Hi all,
> 
> I'm currently working on the LiveCode 8 release notes (in preparation for RC 1!)
> 
> I'd really appreciate some feedback to help me understand how we can make the LiveCode release notes more informative and helpful.
> 
> * What's good about the current LiveCode release notes?
> * How can we make them better?
> * What additional information would be helpful to include?
> * What can be removed or abbreviated to make them more concise?
> 
> For example, here are the LiveCode 8.0.0-dp-11 release notes:
> 
> http://downloads.livecode.com/livecode/8_0_0/LiveCodeNotes-8_0_0_dp_11.pdf
> 
> Please reply and let me know your thoughts -- or feel free to e-mail me off-list.
> 
>                                         Peter
> 
> 
> -- 
> Dr Peter Brett <peter.brett at livecode.com>
> LiveCode Open Source Team
> 
> LiveCode on reddit: https://reddit.com/r/livecode
> 
> _______________________________________________
> use-livecode mailing list
> use-livecode at lists.runrev.com
> Please visit this url to subscribe, unsubscribe and manage your subscription preferences:
> http://lists.runrev.com/mailman/listinfo/use-livecode




More information about the Use-livecode mailing list