OFBiz › OFBiz - Notifications

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

‹ Previous Topic Next Topic ›
 
classic Classic list List threaded Threaded
♦
♦
 1 message Options
Nicolas Malin (Jira)
Reply | Threaded
Open this post in threaded view
♦
♦
|

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

Nicolas Malin (Jira)

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

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

BTW here is the complete stacktrace to show that it's different from the problem I got earlier (resolved with {{classpath 'org.jruby:jruby-complete:9.1.13.0'}}
{code}
C:\projectsASF\ofbiz>gradlew --stacktrace generateOfbizDocumentation
Parallel execution is an incubating feature.
:deleteOfbizDocumentation
:generateOfbizDocumentation
uri:classloader:/gems/rouge-2.0.7/lib/rouge/token.rb:71: warning: already initialized constant Text
uri:classloader:/gems/rouge-2.0.7/lib/rouge/token.rb:71: warning: already initialized constant Error
uri:classloader:/gems/rouge-2.0.7/lib/rouge/token.rb:71: warning: already initialized constant Other
uri:classloader:/gems/rouge-2.0.7/lib/rouge/token.rb:71: warning: already initialized constant Keyword
uri:classloader:/gems/rouge-2.0.7/lib/rouge/token.rb:71: warning: already initialized constant Name
uri:classloader:/gems/rouge-2.0.7/lib/rouge/token.rb:71: warning: already initialized constant Literal
uri:classloader:/gems/rouge-2.0.7/lib/rouge/token.rb:71: warning: already initialized constant Operator
uri:classloader:/gems/rouge-2.0.7/lib/rouge/token.rb:71: warning: already initialized constant Punctuation
uri:classloader:/gems/rouge-2.0.7/lib/rouge/token.rb:71: warning: already initialized constant Comment
uri:classloader:/gems/rouge-2.0.7/lib/rouge/token.rb:71: warning: already initialized constant Generic
uri:classloader:/gems/rouge-2.0.7/lib/rouge/token.rb:178: warning: already initialized constant Num
uri:classloader:/gems/rouge-2.0.7/lib/rouge/token.rb:179: warning: already initialized constant Str
uri:classloader:/gems/rouge-2.0.7/lib/rouge/guessers/modeline.rb:5: warning: already initialized constant EMACS_MODELINE
uri:classloader:/gems/rouge-2.0.7/lib/rouge/guessers/modeline.rb:10: warning: already initialized constant VIM_MODELINE_1
uri:classloader:/gems/rouge-2.0.7/lib/rouge/guessers/modeline.rb:15: warning: already initialized constant VIM_MODELINE_2
uri:classloader:/gems/rouge-2.0.7/lib/rouge/guessers/modeline.rb:17: warning: already initialized constant MODELINES
uri:classloader:/gems/rouge-2.0.7/lib/rouge/regex_lexer.rb:279: warning: already initialized constant MAX_NULL_SCANS
uri:classloader:/gems/rouge-2.0.7/lib/rouge/lexers/bsl.rb:11: warning: already initialized constant KEYWORDS
uri:classloader:/gems/rouge-2.0.7/lib/rouge/lexers/bsl.rb:29: warning: already initialized constant BUILTINS
(RuntimeError) asciidoctor: FAILED: required gem 'rouge' is not installed. Processing aborted.
: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.asciidoctor.internal.AsciidoctorCoreException: org.jruby.exceptions.RaiseException: (RuntimeError) asciidoctor: FAILED: required gem 'rouge' is not installed. Processing aborted.
        at org.asciidoctor.internal.JRubyAsciidoctor.renderFile(JRubyAsciidoctor.java:338)
        at org.asciidoctor.Asciidoctor$renderFile.call(Unknown Source)
        at org.asciidoctor.gradle.AsciidoctorProxyImpl.renderFile(AsciidoctorProxyImpl.groovy:27)
        at org.asciidoctor.gradle.AsciidoctorProxy$renderFile.call(Unknown Source)
        at org.asciidoctor.gradle.AsciidoctorTask.processSingleFile(AsciidoctorTask.groovy:673)
        at org.asciidoctor.gradle.AsciidoctorTask$_processDocumentsAndResources_closure7.doCall(AsciidoctorTask.groovy:656)
        at org.asciidoctor.gradle.AsciidoctorTask.processDocumentsAndResources(AsciidoctorTask.groovy:651)
        ... 26 more
Caused by: org.jruby.exceptions.RaiseException: (RuntimeError) asciidoctor: FAILED: required gem 'rouge' is not installed. Processing aborted.
        at RUBY.require_library(uri:classloader:/gems/asciidoctor-1.5.5/lib/asciidoctor/helpers.rb:30)
        at RUBY.convert_listing_or_literal(uri:classloader:/gems/asciidoctor-pdf-1.5.0.alpha.16/lib/asciidoctor-pdf/converter.rb:1327)
        at RUBY.convert(uri:classloader:/gems/asciidoctor-pdf-1.5.0.alpha.16/lib/asciidoctor-pdf/converter.rb:118)
        at RUBY.convert(uri:classloader:/gems/asciidoctor-1.5.5/lib/asciidoctor/abstract_block.rb:71)
        at RUBY.block in content(uri:classloader:/gems/asciidoctor-1.5.5/lib/asciidoctor/abstract_block.rb:80)
        at org.jruby.RubyArray.map(org/jruby/RubyArray.java:2486)
        at RUBY.content(uri:classloader:/gems/asciidoctor-1.5.5/lib/asciidoctor/abstract_block.rb:80)
        at RUBY.convert_content_for_block(uri:classloader:/gems/asciidoctor-pdf-1.5.0.alpha.16/lib/asciidoctor-pdf/converter.rb:134)
        at RUBY.convert_section(uri:classloader:/gems/asciidoctor-pdf-1.5.0.alpha.16/lib/asciidoctor-pdf/converter.rb:426)
        at RUBY.convert(uri:classloader:/gems/asciidoctor-pdf-1.5.0.alpha.16/lib/asciidoctor-pdf/converter.rb:118)
        at RUBY.convert(uri:classloader:/gems/asciidoctor-1.5.5/lib/asciidoctor/abstract_block.rb:71)
        at RUBY.block in content(uri:classloader:/gems/asciidoctor-1.5.5/lib/asciidoctor/abstract_block.rb:80)
        at org.jruby.RubyArray.map(org/jruby/RubyArray.java:2486)
        at RUBY.content(uri:classloader:/gems/asciidoctor-1.5.5/lib/asciidoctor/abstract_block.rb:80)
        at RUBY.content(uri:classloader:/gems/asciidoctor-1.5.5/lib/asciidoctor/document.rb:1110)
        at RUBY.convert_content_for_block(uri:classloader:/gems/asciidoctor-pdf-1.5.0.alpha.16/lib/asciidoctor-pdf/converter.rb:134)
        at RUBY.convert_document(uri:classloader:/gems/asciidoctor-pdf-1.5.0.alpha.16/lib/asciidoctor-pdf/converter.rb:207)
        at RUBY.convert(uri:classloader:/gems/asciidoctor-pdf-1.5.0.alpha.16/lib/asciidoctor-pdf/converter.rb:118)
        at RUBY.convert(uri:classloader:/gems/asciidoctor-1.5.5/lib/asciidoctor/document.rb:1050)
        at RUBY.convert(uri:classloader:/gems/asciidoctor-1.5.5/lib/asciidoctor.rb:1506)
        at RUBY.convert_file(uri:classloader:/gems/asciidoctor-1.5.5/lib/asciidoctor.rb:1579)
        at RUBY.convertFile(<script>:68)


BUILD FAILED

Total time: 5.995 secs
{code}

So should we not go [the same way thant Spring|https://github.com/spring-projects/spring-framework/commit/55833dc3d1f7bd05881484e488066d07390b2df8]?

> 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)
Free forum by Nabble Edit this page