buildscript { dependencies { classpath fileTree(dir: 'plugins', include: '*.jar', exclude: '*-sources.jar') } } repositories { jcenter() } dependencies { plugin 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.0' } apply plugin: 'org.asciidoctor.gradle.asciidoctor' task copySwagger(type: Copy) { description('Copies swagger generated documents to a temp dir') from file('../swagger/build/asciidoc') into 'build/asciidoc-src' } copySwagger.dependsOn(':swagger:swaggerToAsciidoc') task copySources(type: Copy) { description('Copies swagger generated documents to a temp dir') from file('src/asciidoc') into 'build/asciidoc-src' } asciidoctor { backends = ['html', 'docbook'] sourceDir = file('build/asciidoc-src') sourceDocumentNames = fileTree('build/asciidoc-src') { include 'hws.asc' include 'hws-internal.asc' } } asciidoctor.dependsOn 'copySwagger', 'copySources' task prepXml(type: Copy) { description 'moves our DocBook XML (from asciidoctor) into place' from 'build/asciidoc/hws.xml' into 'xml' dependsOn 'asciidoctor' } ant.importBuild('build.xml') publicsite.dependsOn prepXml pdf.dependsOn prepXml task publicsiteTar(type: Tar) { dependsOn publicsite baseName 'helix-web-services-doc' version null from file('publicsite-generated') compression Compression.GZIP } task docJar(type: Jar) { classifier = 'doc' baseName = 'helix-web-services' from 'publicsite-generated' into 'publicsite/api/doc' } // The ant task doesn't really work in general directories, this dependency // will probably not generically work. //jar.dependsOn 'publicsite' clean { delete "generated-output" delete "publicsite-generated" delete "xml" delete "helix-web-services-doc.tgz" }
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#8 | 18798 | tjuricek |
Report supported platform versions in the default request, if we accept application/json. Added a method to the Java client SDK to check if it's a supported version. |
||
#7 | 18693 | tjuricek |
Move from swagger2markdown project to custom asciidoc generator. This gives us flexibility to do include the context path, for example, or alter the output fairly easily. While StringTemplate is a little tricky to get to know, it works pretty well for our needs, and offers a lot more flexibility for reorganization later. Note: I might change the status method to be version-specific, but in the future, we'll have a method "what versions do you support" which will *not* be version-specific. |
||
#6 | 18569 | tjuricek |
Include the publicsite at the '/doc' path in HWS. Note: The doc pages may require running from hws.jar, your debug mode may not have the new documentation jar in the classpath by default. |
||
#5 | 18551 | tjuricek |
Switch to using swagger-based HTTP methods. Remove old java_client. The swagger documentation generates asciidoc, which is included in the current user guide. We lose some control over the formatting. |
||
#4 | 18238 | tjuricek |
Documentation-building related tweaks: - Reference the documentation from the local build, not the build archive, since that doesn't exist yet. - When gradle calls the publicsite ant task, it should be within the doc/ directory, otherwise, a publicsite-generated/ directory will appear in the root directory (and in the doc/ directory) and you won't get everything in one place. |
||
#3 | 18234 | tjuricek |
Switched to gradle to drive the "hws.archive" build logic. While not absolutely critical, the main build system logic now runs on all OSes. The main trick is to understand that testing tasks can list a "finalizer" dependency to clean up even in the case of failure. The RVM logic will be "pushed out" into the build.conf. Given that we only need Ruby for mock_raymond (the Helix Cloud tests) this isn't that crazy. |
||
#2 | 17324 | tjuricek | Add DocBook output and applied company toolchain to main user guide. | ||
#1 | 17323 | tjuricek |
Revise the documentation to use the JVM-based asciidoctor. This will generate the DocBook XML. I'm still ironing out exactly what the CD process is here. |