Blog post - Introducing Lucee documentation

[Andrew Dixon]

Hi All,

New blog post - http://lucee.org/blog/introducing-lucee-documentation.html

Kind regards,

Andrew

about.me - mso - Lucee Member

[Tom Chiverton]

Would you say the docs there are better or worse or just different than my current bookmark, www.luceedocs.org ?

Tom

[Andrew Penhorwood]

The new docs look great.  I hope there are plans to add cfscript examples.  Kudos to everyone who worked on them.

Andrew Penhorwood

[Jochem van Dieten]

On Thu, May 14, 2015 at 4:18 PM, Andrew Dixon wrote:

New blog post - http://lucee.org/blog/introducing-lucee-documentation.html

Obviously for a first version there is missing quite a bit. Stuff like documentation on operators, on language structure (is it public static void function x() or static public etc.), application.cfc and more that I believe should be in the reference section. But I believe the choice to use source control and a build system instead of a wiki is very much the right one. Especially if it now means that patches will get rejected if they don't have documentation as well.

The big question I have though is licensing. What is the current license and how should contributions be licensed. Is the licensing of the documentation compatible with the Creative Commons licensing Adobe uses for its documentation so both can reference eachother.

Jochem

--

Jochem van Dieten
http://jochem.vandieten.net/

[Nando Breiter]

Andrew,

Looks excellent! I could probably find my way through it, but a more comprehensive guide on how to contribute would be helpful. In particular, how does one work with the BitBucket repository? I've only used GitHub ...

Aria Media Sagl
Via Rompada 40
6987 Caslano
Switzerland

+41 (0)91 600 9601
+41 (0)76 303 4477 cell
skype: ariamedia

--
You received this message because you are subscribed to the Google Groups "Lucee" group.
To unsubscribe from this group and stop receiving emails from it, send an email to lucee+un...@googlegroups.com.
To post to this group, send email to lu...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/CAG1WijXYDtZVmVQQTLnWmv2QaqXGytodb4Yy6nk9_XJCLN-7Og%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

[Andrew Dixon]

Hi Nando,

Firstly let me point out that this is Dom Watson's (Pixl8) projects not mine, don't want to be taking any credit for it!!!

Secondly, in terms of working with BitBucket, it is basically the same a Github, fork the repo, clone it, make changes, commit, push up and the create the pull request. 

Is there anything else that you're not sure about?

Kind regards,

Andrew

about.me - mso - Lucee Member

To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/CAGHrs%3D8xL9d9J-9mDFU1e0WGTrdcQFZ2Q6-Fu5vVJVOsYmaBtA%40mail.gmail.com.

[Nando Breiter]

So I'd need a BitBucket account to fork it, I guess. I was looking at the download links and the round trip path didn't quite click yet. 

Aria Media Sagl
Via Rompada 40
6987 Caslano
Switzerland

+41 (0)91 600 9601
+41 (0)76 303 4477 cell
skype: ariamedia

To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/CAG1WijULNG%3D_8mDFX1UcBTAZx0crzCr11XJmLaOiCT%3D1YTUqPA%40mail.gmail.com.

[Andrew Dixon]

Yes, same as you do on BitBucket.

Kind regards,

Andrew

about.me - mso - Lucee Member

To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/CAGHrs%3D82RqcWEx2-xM%2BAkh4vQMU5kx5xg4SGJn__G0pxV5pT%3DA%40mail.gmail.com.

[Dominic Watson]

> The new docs look great.  I hope there are plans to add cfscript examples.  Kudos to everyone who worked on them.

Thanks :) and yes, absolutely.

> The big question I have though is licensing. What is the current license and how should contributions be licensed. Is the licensing of the documentation compatible with the Creative Commons licensing Adobe uses for its documentation so both can reference eachother.

That's a really good question and something that has been overlooked. Looking into that now. I guess CC would make most sense.

> Firstly let me point out that this is Dom Watson's (Pixl8) project...

To be clear, it is a community project, I just happened to kick it off (indeed, even that is a little unfair - it was first kicked off in conversation with Mark Drew: https://github.com/cybersonic/luceedocs/issues/27)

> Would you say the docs there are better or worse or just different than my current bookmark

Mark's effort actually already contains a little more than the official Lucee angle with its "objects" section. We have a JIRA issue to rectify that. That said, the rest of the content is the same, or has already been enhanced (),  and the official docs provide more opportunity for expansion.

Thanks for the feedback guys,

Dominic

To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/CAG1WijUv_YxxXOPdsN9%3DL3r0aMpUNGZn35Fhh3ZRiMHNvZ7ifw%40mail.gmail.com.

For more options, visit https://groups.google.com/d/optout.

--

Pixl8 Interactive, 3 Tun Yard, Peardon Street, London SW8 3HT, United Kingdom T: +44 [0] 845 260 0726• W: www.pixl8.co.uk• E: in...@pixl8.co.uk

Follow us on: Facebook Twitter LinkedIn

CONFIDENTIAL AND PRIVILEGED - This e-mail and any attachment is intended solely for the addressee, is strictly confidential and may also be subject to legal, professional or other privilege or may be protected by work product immunity or other legal rules. If you are not the addressee please do not read, print, re-transmit, store or act in reliance on it or any attachments. Instead, please email it back to the sender and then immediately permanently delete it. Pixl8 Interactive Ltd Registered in England. Registered number: 04336501. Registered office: 8 Spur Road, Cosham, Portsmouth, Hampshire, PO6 3EB

[Dominic Watson]

@Jochem we've published under a noncommercial share alike creative commons license: http://creativecommons.org/licenses/by-nc-sa/3.0/