+2 for the initiative!
--
typos, misspels, and other weird words brought to you courtesy of my mobile device and its auto-(in)correct feature.
--
Need help right now? Why not have one of the Railo Team help you directly: http://www.getrailo.com/index.cfm/consulting/
---
You received this message because you are subscribed to the Google Groups "Railo" group.
For more options, visit https://groups.google.com/groups/opt_out.
Like you, I thought that most people coming to Railo Server would be previous ACF users. However, I understand that's not the case
The fact that he's writing the documentation for Railo, supporting the company's goals, certainly shifts perspective.
I suppose it all depends on the goal of the docs.
Is it to help those already using the language?
Is it to provide an on-ramp for those choosing Railo vis-a-vis Python, Ruby, etc?
Is it to provide a comprehensive source for those that write CFML apps in many engines?
I know as I look at different languages or APIs or whatnot for projects, I quickly look for a "Documentation" link and whatever I find behind that link tells me a lot about the viability of the product. In many ways documentation becomes a marketing tool (even open source projects market themselves)
With regards of differences between Railo x.y and ACF x.y I think it's a fools errand and would help a few people for a short time compared to using James' time more wisely.
I agree with Cameron,
The thing I need the most is the differences. For instance, I’m sure I heard somewhere that Railo now supports group on cfloop and nested cfloops. When I tried to look, it took me about 20 mins to find it, when really, a google search for “Railo cfloop” should have been all I needed to do.
I’m probably just lazy, but it’s handy that a google search for a cf tag always brings the ACF documentation for that tag to the top of the google search results.
I’m sure with enough inbound links it’d get there eventually…
--
On Fri, Mar 22, 2013 at 12:42 PM, Mark Drew <ma...@getrailo.com> wrote:With regards of differences between Railo x.y and ACF x.y I think it's a fools errand and would help a few people for a short time compared to using James' time more wisely.As someone who has clients on ACF 7, 9, and 10 as well as clients on Railo, I would find documentation of the differences to be extraordinarily valuable. However, I recognize that I may not represent all or even most of Railo's developer base.
If spending time on calling out such differences is not a high priority right now, that's fair. But people are likely to keep asking for it so perhaps these sorts of things would fall under "community responsibility" for the docs. Assuming these are going to be an editable Wiki format, it would be great for the Railo team to define a documentation framework for this sort of activity to be contained within in the docs.Call it "The Railo Documentation Manifesto" - a mission statement and clear roadmap for documentation contributors to follow. Map out what the Railo team is going to do themselves and give an A, B, C of what volunteers can do and how to do it so that the docs don't get messy.
While we're on ideas for special content callouts... There is a pretty good bit of blog content out there around examples and usage of the CFML language and Railo. How about a section on each page (or a link to a companion page for each) that lists "related reading" or "supplemental reading". It may be a challenge to vet the links, but linking to Brian Kotek's ORM blog series or John Wish's ORM book would be FAN-FRACKING-TASTIC to find right there as a callout in the ORM section. You could pretty much index Ray Camden and Ben Nadel's blogs against the entire doc set too if they didn't mind, which they might...
Happy to :)
Maybe a “powered by railo” widget people can just copy and paste in their footers would be good. I see there’s an “unofficial” logo here, but a code snippet would be nice too
http://www.getrailo.org/index.cfm/community/spread-the-word/
Tom.
From: ra...@googlegroups.com [mailto:ra...@googlegroups.com] On Behalf Of Igal @ getRailo.org
Sent: 22 March 2013 14:15
To: ra...@googlegroups.com
Subject: Re: [railo] Developer documentation
so if you have a "personal" site (by personal I mean, a site that is yours and not a client's) an inbound link would be greatly appreciated ;)
On 3/22/2013 11:10 AM, Tom Miller wrote:
I’m sure with enough inbound links it’d get there eventually…
--
I like this idea a lot. I'd pencilled in "Useful resources and further reading", but of course in-line links would be terrific. It wouldn't be too difficult to produce some sort of verification tool in the long term.
I really think that documentation about moving from X to Railo should be done by the community.
--
Then share your knowledge in the wiki.
Of course we will have to if that's our only option, but it's also important for the Railo team to understand that your user base does think that a "differences between ACF and Railo" is important.
Sure. I get it.
On Sun, Mar 24, 2013 at 4:33 PM, Risto <ck.web...@gmail.com> wrote:
Of course we will have to if that's our only option, but it's also important for the Railo team to understand that your user base does think that a "differences between ACF and Railo" is important.
We understand this but you are a vocalminority.
Look, go have a look at the framework one documentation. It has information on what it does and how you do it. It doesn't have information on how to use fw/1 if you use model glue.
There are political and practical implications to that kind of documentation.
I am paying someone to write documentation. I want to get the basics covered.
Really? From a position of not having any stats to demonstrate anything one way or another, this really surprises me. I would have thought the bulk of Railo users would be people migrating from ColdFusion, not people entirely new to CFML. I'm not disagreeing with you, Mark, but that you suggesting otherwise really surprises me.
Like it or not, there are politics involved. Anyone in the community can publish a "differences" guide, but Railo don't necessarily want to publish a "here's how to migrate away from ACF" guide because it could be taken the wrong way.
Like Mark says, it's community developers who will have the most experience doing this anyway. And from my experience, following a "guide" won't help you find all the edge cases in your code - you basically need to test your code on Railo and see what breaks, then fix it. No amount of reading compatibility tables or guide can do this part for you unfortunately.
Thank you for your opinions Adam.
--
I also read all the download feedback ;)
I try not to pull stuff out of my arse.
--
-In your TOC I don't see why you have a section on "free" and much later on a section on "open source". They are linked. Also, being open source brings with it the 4 freedoms, which I have always found to be a powerful message.
-I would prefer that the documentation going forward is not separated by Railo version, but that there are notes telling when it was introduced.
-It would be nice if people could easily post corrections and clarifications alongside each section or feature.
-Having the full documentation rather than just the differences between ACF would be awesome.
-It would be nice to be able to download the documentation as a PDF.
-You have some broad background sections. Perhaps for those you could be a cat-herder and get others to create a first draft or provide links so that you are just editing and compiling the general stuff and putting most of your attention on developer documentation.
Good luck and thank you. This will be a very nice resource.
G'day Mark:
Yes, the results will definitely be skewed to only report on people who a) participate on the various forums I posted this to; b) are inclined to participate in surveys. However I don't think the extension of your logic is sound in that "EVERYONE will be coming form one CFML engine or another". Are there no people on this list who entered the CFML community via using Railo? I hope you're not right on that count. Or if so, it mitigates the skewing somewhat.
Do you have any metrics of people who hit the Railo download page, but don't fill in that form? What are those numbers like?
It's good that you're getting that 30-40% though. That's very encouraging. Hopefully a bunch of those people are participating here too!
Cheers for thinking about this, Mark.
I'm writing to canvass your opinions on the developer documentation for Railo Server.I'm just starting to write the documentation for Railo and I'd value your input on what should go into it (or be left out of it). At this point, I'd like to sketch out the "table of contents", in its entirety, and then fill in the detail afterwards, rather than start writing haphazardly.You can see my ideas for the documentation on Railo's github:Please let me know if you have any ideas or comments.The biggest section is likely to be "Developing applications with Railo Server"... and I'd really like to find out how you think this should go. Are you interested in:* sample apps* tutorials* design patterns* explanation of all Railo Server's language features* enhancing Railo Server* editors / IDEs* integrating Railo Server with other products, e.g. search engines, message queues* something else?Let me know what else you'd like to see in this section... All opinions welcome!On the other hand, perhaps you think it should be very lightweight and that people should use ACF documentation in general, with Railo Server documentation covering the Railo-Server-specific matters only.Many thanks,James
--
Depending on what info is more important to you, perhaps pushing the name / email address bit down further, asking for the usage metrics first? Speaking for myself, I will never provide my name and email address if I don't have to, fearing spam (and I simply don't want to ever hear again from whoever's website I am on, generally). But I will give metric info like the other questions quite freely because I know it can help them, and is no "cost" for me. Obviously this is only me, so I cannot speak to how other people approach forms.
GentsI want to get back to James initial question. And add a few suggestions:a) I applaud the effort. Whatever form it takes it is an improvement.b) I would not underestimate the need for a complete tag reference with basic examples. This seems placed into your TOC inline in the Developing Apps area. I do believe it probably warrants its own large section/manual organized by tag function area. I would suggest that the Script elements are also mentioned within each tag reference entry. If you script it, how + example.
c) If the Cloud is the future, it needs a larger coherent place in App Docs, : How to design an app for the cloud, manage it, what are coding considerations, what does file system really mean, etc. The sample app showing off how to scale Railo cluster on Amazon? A control panel that can brings up instances, shows loads, session in cluster?
d) If I were in a new developer's shoes I would want to find out what I can build with this thing based on that I would decide whether I wanted to learn any more. This is what Joomla and Wordpress did for Php; they catapulted php into dev awareness. So, time spent on a solid developer sample apps that show the power of the language and eco-system, is, in my opinion, time well spent.
For example, Microsoft uses the AdventureWorks concept in many of its dev tools to highlight features and creating attractive sample apps. Could a similar concept app exist for Railo? Maybe a sample Pinterest type site, allowing people to pin images, videos, blogs: rate and comment? A sample webstore? Walk route app? (scenic walks, ratings, comments, maps) + mobile 4 square comments?Mobile integration to any sample app? Chat?Just my 2.Best,Bilal
We did an application for video sharing for the book. Maybe that application to go into this?. Otherwise we also did a task manager application for the book which can also be suitable candidate?
--
Sure. I get it.
So write it already.
—
Sent from Mailbox for iPhone
On Sun, Mar 24, 2013 at 4:33 PM, Risto <ck.web...@gmail.com> wrote:
Of course we will have to if that's our only option, but it's also important for the Railo team to understand that your user base does think that a "differences between ACF and Railo" is important.
Surely that is a bug that we must look at?
Surely that is a bug that we must look at?
--
Need help right now? Why not have one of the Railo Team help you directly: http://www.getrailo.com/index.cfm/consulting/
---
You received this message because you are subscribed to the Google Groups "Railo" group.
For more options, visit https://groups.google.com/groups/opt_out.