OFBiz › OFBiz - Notifications

[jira] [Commented] (OFBIZ-9873) Create a PoC for a documentation system for OFBiz based on Asciidoc

_‹ Previous Topic Next Topic _›

Classic

List

Threaded

1 message

Nicolas Malin (Jira)

[jira] [Commented] (OFBIZ-9873) Create a PoC for a documentation system for OFBiz based on Asciidoc

[ https://issues.apache.org/jira/browse/OFBIZ-9873?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16391206#comment-16391206 ]

Jacques Le Roux commented on OFBIZ-9873:
----------------------------------------

Hi Taher,

I just tried on Win7 after an svn up (plugins also) and got this:
{code}
C:\projectsASF\ofbiz>gradlew
Download https://jcenter.bintray.com/org/asciidoctor/asciidoctor-gradle-plugin/1.5.7/asciidoctor-gradle-plugin-1.5.7.pom
Download https://jcenter.bintray.com/org/asciidoctor/asciidoctorj-pdf/1.5.0-alpha.16/asciidoctorj-pdf-1.5.0-alpha.16.pom
Download https://jcenter.bintray.com/org/asciidoctor/asciidoctorj/1.5.5/asciidoctorj-1.5.5.pom
Download https://jcenter.bintray.com/org/jruby/jruby-complete/9.1.12.0/jruby-complete-9.1.12.0.pom
Download https://jcenter.bintray.com/org/jruby/jruby-artifacts/9.1.12.0/jruby-artifacts-9.1.12.0.pom
Download https://jcenter.bintray.com/org/jruby/jruby-parent/9.1.12.0/jruby-parent-9.1.12.0.pom
Download https://jcenter.bintray.com/org/asciidoctor/asciidoctor-gradle-plugin/1.5.7/asciidoctor-gradle-plugin-1.5.7.jar
Download https://jcenter.bintray.com/org/asciidoctor/asciidoctorj-pdf/1.5.0-alpha.16/asciidoctorj-pdf-1.5.0-alpha.16.jar
Download https://jcenter.bintray.com/org/asciidoctor/asciidoctorj/1.5.5/asciidoctorj-1.5.5.jar
Download https://jcenter.bintray.com/org/jruby/jruby-complete/9.1.12.0/jruby-complete-9.1.12.0.jar
:compileJava
Note: Some input files use or override a deprecated API.
Note: Recompile with -Xlint:deprecation for details.
Note: Some input files use unchecked or unsafe operations.
Note: Recompile with -Xlint:unchecked for details.
:processResources UP-TO-DATE
:classes
:jar
:assemble
:compileTestJava
:processTestResources UP-TO-DATE
:testClasses
:test
:check
:build

BUILD SUCCESSFUL

Total time: 2 mins 3.499 secs
{code}

{code}
C:\projectsASF\ofbiz>gradlew --stacktrace generateOfbizDocumentation
:generateOfbizDocumentation FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':generateOfbizDocumentation'.
> Error running Asciidoctor

* Try:
Run with --info or --debug option to get more log output.

* Exception is:
org.gradle.api.tasks.TaskExecutionException: Execution failed for task ':generateOfbizDocumentation'.
at org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter.executeActions(ExecuteActionsTaskExecuter.java:84)
at org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter.execute(ExecuteActionsTaskExecuter.java:55)
at org.gradle.api.internal.tasks.execution.SkipUpToDateTaskExecuter.execute(SkipUpToDateTaskExecuter.java:61)
at org.gradle.api.internal.tasks.execution.ValidatingTaskExecuter.execute(ValidatingTaskExecuter.java:58)
at org.gradle.api.internal.tasks.execution.SkipEmptySourceFilesTaskExecuter.execute(SkipEmptySourceFilesTaskExecuter.java:88)
at org.gradle.api.internal.tasks.execution.ResolveTaskArtifactStateTaskExecuter.execute(ResolveTaskArtifactStateTaskExecuter.java:45)
at org.gradle.api.internal.tasks.execution.SkipTaskWithNoActionsExecuter.execute(SkipTaskWithNoActionsExecuter.java:51)
at org.gradle.api.internal.tasks.execution.SkipOnlyIfTaskExecuter.execute(SkipOnlyIfTaskExecuter.java:54)
at org.gradle.api.internal.tasks.execution.ExecuteAtMostOnceTaskExecuter.execute(ExecuteAtMostOnceTaskExecuter.java:43)
at org.gradle.api.internal.tasks.execution.CatchExceptionTaskExecuter.execute(CatchExceptionTaskExecuter.java:34)
at org.gradle.execution.taskgraph.DefaultTaskGraphExecuter$EventFiringTaskWorker.execute(DefaultTaskGraphExecuter.java:233)
at org.gradle.execution.taskgraph.DefaultTaskGraphExecuter$EventFiringTaskWorker.execute(DefaultTaskGraphExecuter.java:215)
at org.gradle.execution.taskgraph.AbstractTaskPlanExecutor$TaskExecutorWorker.processTask(AbstractTaskPlanExecutor.java:74)
at org.gradle.execution.taskgraph.AbstractTaskPlanExecutor$TaskExecutorWorker.run(AbstractTaskPlanExecutor.java:55)
at org.gradle.internal.concurrent.ExecutorPolicy$CatchAndRecordFailures.onExecute(ExecutorPolicy.java:54)
at org.gradle.internal.concurrent.StoppableExecutorImpl$1.run(StoppableExecutorImpl.java:40)
Caused by: org.gradle.api.GradleException: Error running Asciidoctor
at org.asciidoctor.gradle.AsciidoctorTask.processDocumentsAndResources(AsciidoctorTask.groovy:660)
at org.asciidoctor.gradle.AsciidoctorTask$_processAsciidocSources_closure6.doCall(AsciidoctorTask.groovy:606)
at org.asciidoctor.gradle.AsciidoctorTask.withAsciidoctor(AsciidoctorTask.groovy:883)
at org.asciidoctor.gradle.AsciidoctorTask.processAsciidocSources(AsciidoctorTask.groovy:584)
at org.gradle.internal.reflect.JavaMethod.invoke(JavaMethod.java:73)
at org.gradle.api.internal.project.taskfactory.DefaultTaskClassInfoStore$StandardTaskAction.doExecute(DefaultTaskClassInfoStore.java:141)
at org.gradle.api.internal.project.taskfactory.DefaultTaskClassInfoStore$StandardTaskAction.execute(DefaultTaskClassInfoStore.java:134)
at org.gradle.api.internal.project.taskfactory.DefaultTaskClassInfoStore$StandardTaskAction.execute(DefaultTaskClassInfoStore.java:123)
at org.gradle.api.internal.AbstractTask$TaskActionWrapper.execute(AbstractTask.java:624)
at org.gradle.api.internal.AbstractTask$TaskActionWrapper.execute(AbstractTask.java:607)
at org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter.executeAction(ExecuteActionsTaskExecuter.java:95)
at org.gradle.api.internal.tasks.execution.ExecuteActionsTaskExecuter.executeActions(ExecuteActionsTaskExecuter.java:76)
... 15 more
Caused by: org.jruby.exceptions.RaiseException: (SystemCallError) Unknown error (SystemCallError) 123 - FindFirstFile
at RUBY.symlink?(uri:classloader:/jruby/kernel/file.rb:141)
at RUBY.<module:Prawn>(uri:classloader:/gems/prawn-2.2.2/lib/prawn.rb:11)
at RUBY.<main>(uri:classloader:/gems/prawn-2.2.2/lib/prawn.rb:9)
at org.jruby.RubyKernel.require(org/jruby/RubyKernel.java:961)
at RUBY.(root)(uri:classloader:/META-INF/jruby.home/lib/ruby/stdlib/rubygems/core_ext/kernel_require.rb:1)
at RUBY.<main>(uri:classloader:/META-INF/jruby.home/lib/ruby/stdlib/rubygems/core_ext/kernel_require.rb:54)
at org.jruby.RubyKernel.require(org/jruby/RubyKernel.java:961)
at RUBY.(root)(uri:classloader:/gems/asciidoctor-pdf-1.5.0.alpha.16/lib/asciidoctor-pdf/converter.rb:3)
at RUBY.<main>(uri:classloader:/jruby/kernel/kernel.rb:1)
at org.jruby.RubyKernel.require(org/jruby/RubyKernel.java:961)
at RUBY.require_relative(uri:classloader:/jruby/kernel/kernel.rb:13)
at RUBY.<main>(uri:classloader:/gems/asciidoctor-pdf-1.5.0.alpha.16/lib/asciidoctor-pdf.rb:3)

BUILD FAILED

Total time: 6.48 secs
{code}

Looked at https://github.com/jruby/jruby/issues/4745. Adding classpath 'org.jruby:jruby-complete:9.1.13.0' in build.gradle worked. So this change seems needed for Windows users.

> Create a PoC for a documentation system for OFBiz based on Asciidoc
> -------------------------------------------------------------------
>
> Key: OFBIZ-9873
> URL: https://issues.apache.org/jira/browse/OFBIZ-9873
> Project: OFBiz
> Issue Type: Improvement
> Affects Versions: Upcoming Branch
> Reporter: Taher Alkhateeb
> Assignee: Taher Alkhateeb
> Priority: Minor
> Fix For: Upcoming Branch
>
> Attachments: OFBIZ-9873.patch, OFBIZ-9873.patch
>
>
> In reference to the [discussion thread|https://lists.apache.org/thread.html/8cc03b7b8733512244129ddae9e0cc1fb2a28e3e250aba1c8cf678f8@%3Cdev.ofbiz.apache.org%3E] this is an attempt to create a PoC for OFBiz documentation system based on Asciidoc. The main assumptions for the design of this system are:
> - The documentation language to use is Asciidoc
> - The documentation tool is Asciidoctor
> - Publishing happens through Gradle using the asciidoctor gradle plugin (not the OFBiz framework or anything else).
> - The only place where we write documentation is inside the code base
> - Every component contains its own documentation
> - General documentation goes to either a standalone directory or a generic component like common or base
> - As much as possible, documentation files are small and focused on one topic. And then other longer documents are constructed from these snippets of documentation.
> - We publish to all formats including PDF for users, or HTML for embedded help and wiki pages. So OFBiz does not parse docbook for its help system, instead it just renders generated HTML.

--
This message was sent by Atlassian JIRA
(v7.6.3#76005)