Documentation process

[Adam Cameron]

G'day

A new feature has been partially added to Lucee, as per here: https://luceeserver.atlassian.net/browse/LDEV-47

There are no docs for this that I can find, which has me wondering what the documentation process is.

To my mind part of doing the work is also doing the docs (not that it necessarily needs to be the same person), is this how the internal Lucee dev process works?

At the very least, should a LD ticket be raised? I can't find one.

Cheers for any clarification.

-- 

Adam

[Mark Drew]

Maybe just add a documentation ticket relating to this ticket. Then anyone is able to contribute the documentation, they can see what is missing and then do a commit to the documentation site or wiki?

If a ticket is finished and the developer (or community) deems documentation necessary for that particular ticket then a doc ticket should be opened. as I can see not all tickets require docs, for example bug fixes or underlying code changes etc. 

Just my 2p

Mark Drew


develop • deploy • deliver
http://charliemikedelta.com

--
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/d1ca78eb-a3d2-4d44-9038-0e2b9b4d63e4%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[AJ Mercer]

is 'for' on
http://docs.lucee.org/

It did not show up in search results.

--

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/d1ca78eb-a3d2-4d44-9038-0e2b9b4d63e4%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

--

AJ Mercer
<webonix:net strength="Industrial" /> | <webonix:org community="Open" />
http://twitter.com/webonix

[Dominic Watson]

Process and workflows need to be defined, certainly and I'll be pushing for that when I can. For now though, creating a ticket would be appreciated.

AJ, we have a ticket for documenting the language itself (which 'for' would come under). It's nowhere as yet.

I'm planning on pushing a collective effort around this and the documentation in general. Watch this space.

Dominic

To view this discussion on the web visit https://groups.google.com/d/msgid/lucee/CAPURtC0gBV_M54EX1CGV1uHxLYP%2Bs8N5VOWmWqdp6mW1ZY2nvw%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

[Adam Cameron]

On Tuesday, 2 June 2015 10:22:00 UTC+1, Mark Drew wrote:

Maybe just add a documentation ticket relating to this ticket.

The question wasn't related to dealing with this particular situation, it asking for clarification of the process in general.

-- 

Adam 

[Mark Drew]

I was suggesting this as a workflow going forward. 

Mark Drew


develop • deploy • deliver
http://charliemikedelta.com

--
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/5ef02779-62d2-4c0c-adb2-89c029635f27%40googlegroups.com.

[Adam Cameron]

On Tuesday, 2 June 2015 11:04:39 UTC+1, Dominic Watson wrote:

Process and workflows need to be defined, certainly and I'll be pushing for that when I can. For now though, creating a ticket would be appreciated.

Tickets raised:

• Document support for (element in list)
  
• Ensure new features have documentation requirements covered
  

-- 

Adam

 

[Dominic Watson]

Thanks Adam, I've moved / updated them (title changed for the latter, should you be searching for it later).

--

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/f2273bd1-3ca0-4047-958c-49a555aa0d3a%40googlegroups.com.

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