Has anyone created a ColdBox API docset for Dash? I’m probably going to attempt it but I thought I’d ask in case someone beat me to it.
Not that I know of, but that would be interesting. I’m curious how many people use that service. I see they have ColdFusion docs in there.
Thanks!
~Brad
ColdBox Platform Evangelist
Ortus Solutions, Corp
E-mail: brad@coldbox.org
ColdBox Platform: http://www.coldbox.org
Blog: http://www.codersrevolution.com
It’s Mac only at the moment, but there are a large library of docsets already available, including ColdFusion (the Railo team is working on one too).
I’ll post back when I get a chance to import the CB docs.
Let me know what you need.
Luis F. Majano
CEO
Ortus Solutions, Corp
www.ortussolutions.com
ColdBox Platform: http://www.coldbox.org
Linked In: http://www.linkedin.com/pub/3/731/483
Blog: http://www.luismajano.com
IECFUG Manager: http://www.iecfug.com
Thanks Luis, I think I can just build it from the API docs download you provide.
Once I build the docset, it might be nice to put it somewhere as an official docset feed. I’ll let you know when I get to that point.
Yes, please do. Would be great to add our Ref Cards as well to them via their cheat sheets stuff. Can you help with that too?
I can bribe you with some Amazon Gift Cards, if you can help us out 
Luis F. Majano
CEO
Ortus Solutions, Corp
www.ortussolutions.com
ColdBox Platform: http://www.coldbox.org
Linked In: http://www.linkedin.com/pub/3/731/483
Blog: http://www.luismajano.com
IECFUG Manager: http://www.iecfug.com
I’ve not seen the cheat sheet thing, but I will look into it. No bribes necessary, I’m quite happy to contribute.
Is there a 32x32 png of a ColdBox icon somewhere I can use for the docset?
Luis F. Majano
CEO
Ortus Solutions, Corp
www.ortussolutions.com
ColdBox Platform: http://www.coldbox.org
Linked In: http://www.linkedin.com/pub/3/731/483
Blog: http://www.luismajano.com
IECFUG Manager: http://www.iecfug.com
Social: twitter.com/lmajano facebook.com/lmajano
There’s some here:
http://www.coldbox.org/media/logos
Thanks!
~Brad
ColdBox Platform Evangelist
Ortus Solutions, Corp
E-mail: brad@coldbox.org
ColdBox Platform: http://www.coldbox.org
Blog: http://www.codersrevolution.com
Hey guys, I have a few docsets built for 3.8.1, 3.7.0, 3.6.0. I’m wondering what is the best strategy for handling versioning. Since these docsets can be hosted with a simple XML feed, and updates can be pulled from the Dash app, I was thinking a good strategy might be to generate a docset feed for each major version (3.8, 3.7, etc) and then update the feed for minor version changes. So at the moment the feed for 3.8 would give the docset for 3.8.1, but we could update it when/if 3.8.2 comes out.
Or do you think we need individual feeds for every minor version, to parallel the list on the API page (http://www.coldbox.org/api)?
Luis, do you want to host these feeds on coldbox.org? I can give you what you need (a simple XML file and an archive with the docset in it).
That’s great news, yes, that would be great, we can host them.
Maybe we can do a connect session and you can show me how you built them, I would like to include it in our build process so we can automate it.
Luis F. Majano
CEO
Ortus Solutions, Corp
www.ortussolutions.com
ColdBox Platform: http://www.coldbox.org
Linked In: http://www.linkedin.com/pub/3/731/483
Blog: http://www.luismajano.com
IECFUG Manager: http://www.iecfug.com
Yes, you could automate it quite easily. I am going to put what I have done so far on GitHub, I’ll send you a link to the project when I get it pushed.
The trickiest part is creating the search index, which is a SqlLite database. I used an example Python script as a starting point. You can use that or I was contemplating rewriting it in CF. I’ve never used SQLLite as a datasource before, though a cursory Google looks like it’s possible.
I’ll post back here when I have the project on GitHub.
So cool! Cant wait!
Thanks Sean!
Will take a look. How did you build it out?
Luis F. Majano
CEO
Ortus Solutions, Corp
www.ortussolutions.com
ColdBox Platform: http://www.coldbox.org
Linked In: http://www.linkedin.com/pub/3/731/483
Blog: http://www.luismajano.com
IECFUG Manager: http://www.iecfug.com
The README in the project has the details, but basically I used a Python script that crawls through the classes, packages, and methods links in your docs to build the index.
Luis, am I correct in deducing that your build process uses the /apidocs/ColdDoc.cfc generate() method along with /apidocs/[coldbox|wirebox|etc].cfm to create the docs?
When I have time (hopefully sometime this week) I could work on a pull request for you that would add the creation of the docset to this process. I think the only thing I would really need to know is what type of environment you run this build in, since I need to create a sqlite datasource for doing the index (unless we can cfexecute the python script - which would also require certain environment dependencies, some python libraries).
I’m pretty exclusively Railo, I’ve been out of the ACF ecosystem for several years now… so take that for what it is
- Sean
Hi Sean.
We run the build either on my Mac or our staging Ubuntu integration server. This will be on railo as well.