Comments on: GitHub Pages: publish your Grails plugin docs

By: Peter

Peter — Tue, 31 Aug 2010 09:23:17 +0000

Thanks Luke. I’ve pushed the changed so the script in the GWT plugin has the fix.

By: Luke Daley

Luke Daley — Tue, 31 Aug 2010 02:10:22 +0000

The following patch will make the publish-github script work with 1.3:

— untitled
+++ (clipboard)
@@ -58,7 +58,13 @@
// We have to generate the docs on the current branch because the
// ‘docs’ target depends on ‘compile’, which of course requires all
// the source files.
- def docsDir = new File(“${basedir}/docs”)
+ def docsDir
+ try {
+ docsDir = grailsSettings.docsOutputDir
+ } catch (MissingPropertyException e) {
+ docsDir = new File(“${basedir}/docs”)
+ }
+
ant.delete(dir: docsDir.absolutePath)
docs()

By: Armbruster IT Blog » new Grails plugin released: modproxybalancer

Armbruster IT Blog » new Grails plugin released: modproxybalancer — Tue, 25 May 2010 12:18:42 +0000

[...] note: this is my first Grails plugin with it’s sources residing on github.com. Thanks to Peter Ledbrook’s excellent blog post, I was able to use GitHub pages for the documentation. Categories: Uncategorized Tags: [...]

By: GitHub Pages: publica tu documentación de plugins de Grails (inglés) - Observatorio de Grails

Fri, 12 Mar 2010 11:08:15 +0000

[...] información sobre GitHub Pages: publish your Grails plugin doc (traducido al [...]

By: Mike Brevoort

Mike Brevoort — Mon, 08 Mar 2010 13:18:13 +0000

Very clever Peter. To Graeme’s point would be great if there were a more turnkey way to do this, but to me it would make sense that this would integrate more tightly into the Plugin Portal. I especially like the change notification on the plugin portal docs (though not 25 emails when someone is editing large changes and incrementally saving).

Is it more appropriate to consider what improvements should be made to the plugin portal? Subpage support with the ability to publish all docs from script? Also, would be cool if within core a dev plugin there was a way to fire up a local webserver to serve the grails doc for the version you’re running as well as a consolidated collection of plugin docs for all the plugins installed in the project.

I like the though of trying to maintain consolidated documentation for plugins.

By: Peter

Peter — Mon, 08 Mar 2010 12:41:04 +0000

Of course I thought about it In fact, a general GitHub plugin may be appropriate. It’d be a tiny plugin, but I guess that’s OK. To be honest, I’d prefer something that published direct to the plugin portal though.

By: Graeme Rocher

Graeme Rocher — Mon, 08 Mar 2010 09:40:30 +0000

Would be good if as many of these steps as possible were packages into a plugin so that once you have setup the ‘gh-pages’ tracking branch its as simple as:

grails install-plugin github-pages
grails publish-github –push

To have a site published. The plugin could install the necessary templates and create the initial documentation structure etc.

Come on Peter you know you want to