[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=16475644#comment-16475644 ] Taher Alkhateeb commented on OFBIZ-9873: committed in r1831619. Thank you for the help > 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-rouge-coderay.patch, OFBIZ-9873.patch, > 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)
[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=16473095#comment-16473095 ] Jacques Le Roux commented on OFBIZ-9873: Thanks, it works for me, good to commit. > 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-rouge-coderay.patch, OFBIZ-9873.patch, > 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)
[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=16473082#comment-16473082 ] Taher Alkhateeb commented on OFBIZ-9873: I have attached a patch which should resolve the issue for now by disabling PDF output to windows machines. Please confirm if this is suitable and we can apply it to the code base. > 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-rouge-coderay.patch, OFBIZ-9873.patch, > 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)
[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=16473013#comment-16473013 ] Jacques Le Roux commented on OFBIZ-9873: Hi Taher, bq. Again, read my answer above for the EntitySync issue OK got it for including, thanks bq. Maybe a better option is to simply turn off PDF in windows for now? WDYT Yes, people can always turns to *nix platforms for that, it's OK with me. Do we need to do something or only documenting and then close? > 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-rouge-coderay.patch, 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)
[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=16471806#comment-16471806 ] Taher Alkhateeb commented on OFBIZ-9873: Again, read my answer above for the EntitySync issue Doing some research, it seems coderay development is stalling, and rouge supports many more languages. Maybe a better option is to simply turn off PDF in windows for now? WDYT > 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-rouge-coderay.patch, 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)
[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=16467918#comment-16467918 ] Jacques Le Roux commented on OFBIZ-9873: Thanks Sharan, Yes indeed, I can see it in the user doc PDF, but nothing for EntitySync in developer doc. BTW I just saw that this doc is mostly empty. I'll check that... > 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-rouge-coderay.patch, 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)
[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=16467483#comment-16467483 ] Sharan Foga commented on OFBIZ-9873: Hi [~jacques.le.roux] I use the generateOfbizDocumentation to test any changes I do for the human resources documentation and the pdf and html for everything is coming out fine for me. > 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-rouge-coderay.patch, 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)
[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=16467299#comment-16467299 ] Jacques Le Roux commented on OFBIZ-9873: Hi Taher, bq. So can you share what you did exactly as a workaround? It seems from some of the research I've done that the problem really won't go away until the folks at asciidoctor release a new version with new dependencies. Yes, I simply replaced rouge by coderay like the Spring team does for now. I suggest that we replace rouge by coderay until rouge works in Windows, see [^OFBIZ-9873-rouge-coderay.patch] for that bq. generateOfbizDocumentation essentially publishes everything consolidated as one But that does not work for framework/entityext/src/doc/asciidoc/EntitySync-manual.adoc It's not included anywhere in a PDF or HTML at generation. So I need to do my own Gradle task or? I see that humanres.adoc has no way to generate the PDF/HTML too. So what do I miss? Are *.ad [^OFBIZ-9873-rouge-coderay.patch] oc like humanres.adoc and EntitySync-manual.adoc not supposed to generate PDF/HTML? I guess we need to discuss that on dev ML, no? > 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-rouge-coderay.patch, 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)
[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=16467196#comment-16467196 ] Taher Alkhateeb commented on OFBIZ-9873: Hello Jacques, Thank you for reporting this, it's always good to find these problems across different operating systems. It keeps us careful and on our toes. So can you share what you did exactly as a workaround? It seems from some of the research I've done that the problem really won't go away until the folks at asciidoctor release a new version with new dependencies. As with respect to your question of how to generate a certain document. The answer is, out-of-the-box, you don't. I've designed the system with two commands: generateOfbizDocumentation essentially publishes everything consolidated as one, so you need to "include" whatever you want into the final manual. The other task "generatePluginDocumentation" does the same thing but only for a single component. You can read the implementation in build.gradle to understand the specifics. > 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)
[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=16467112#comment-16467112 ] Jacques Le Roux commented on OFBIZ-9873: I replaced rouge by coderay, it works here. I though still don't know how to generate a PDF for EntitySync-manual.adoc. > 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)
[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=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
[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=16465663#comment-16465663 ] Jacques Le Roux commented on OFBIZ-9873: Also, how to you generate HTML/PDF documentation for a (WIP) document like [https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk/framework/entityext/src/doc/asciidoc/EntitySync-manual.adoc] ? Thanks > 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)
[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=16406460#comment-16406460 ] Jacques Le Roux commented on OFBIZ-9873: Thanks Taher > 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)
[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=16406254#comment-16406254 ] Taher Alkhateeb commented on OFBIZ-9873: Fix committed in r1827302. Thank you Jacques for your research, solution, and testing. Based on your feedback and trust in system stability I will close this issue > 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)
[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=16404533#comment-16404533 ] Jacques Le Roux commented on OFBIZ-9873: +1 > 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)
[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=16404492#comment-16404492
]
Taher Alkhateeb commented on OFBIZ-9873:
I see, you up-numbered without excluding from asciidoctorj-pdf. It works but
would be fragile for the future.
So my recommendation if everyone agrees is to apply Jacque's patch with the
below comment. This way we can come back to it and remove it later when the
issue is fixed with a future release of asciidoctorj-pdf.
{code}
Index: build.gradle
===
--- build.gradle (revision 1827146)
+++ build.gradle (working copy)
@@ -31,6 +31,8 @@
classpath 'at.bxm.gradleplugins:gradle-svntools-plugin:latest.release'
classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.7'
classpath 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.16'
+ // asciidoctorj-pdf bug workaround - override jruby. See OFBIZ-9873
+ classpath 'org.jruby:jruby-complete:9.1.13.0'
}
}
apply plugin: 'java'
{code}
> 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)
[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=16404468#comment-16404468
]
Jacques Le Roux commented on OFBIZ-9873:
I wrote above
bq. Adding classpath 'org.jruby:jruby-complete:9.1.13.0' in build.gradle
worked.
{code}
but this is more clear:
Index: build.gradle
===
--- build.gradle(revision 1826795)
+++ build.gradle(working copy)
@@ -31,6 +31,7 @@
classpath 'at.bxm.gradleplugins:gradle-svntools-plugin:latest.release'
classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.7'
classpath 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.16'
+classpath 'org.jruby:jruby-complete:9.1.13.0'
}
}
apply plugin: 'java'
{code}
And yes I had no problem overriding
> 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)
[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=16404047#comment-16404047 ] Taher Alkhateeb commented on OFBIZ-9873: Oh, I mean overriding the dependency! What did you type exactly for a fix in build.gradle? > 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)
[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=16403986#comment-16403986 ] Jacques Le Roux commented on OFBIZ-9873: Hi Taher, Yes it generates the HTML and PDF files. How do you test the "dependency override"? > 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)
[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=16397226#comment-16397226 ] Michael Brohl commented on OFBIZ-9873: -- Great, thank you, Taher! (y) > 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)
[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=16394458#comment-16394458 ] Taher Alkhateeb commented on OFBIZ-9873: Ok, so checking the dependencies of the system, asciidoctorj pulls in "org.jruby:jruby-complete:1.7.26" so we will be jumping many versions. It also seems like this issue is quite common in windows (issues with JRuby). Did you test the dependency override? Does it seem to be behaving well on your computer? Did you get both HTML and PDF outputs? > 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)
[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=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
[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=16391028#comment-16391028 ] Taher Alkhateeb commented on OFBIZ-9873: PoC is officially in trunk in r1826199. The rest of the discussion on how to move this project forward will happen in the [wiki page|https://cwiki.apache.org/confluence/display/OFBIZ/OFBiz+Documentation+Team] > 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 > 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)
[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=16370245#comment-16370245 ] Taher Alkhateeb commented on OFBIZ-9873: attached a document with minor modifications to the original structure. Will discuss this on the mailing list. > 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 > 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)
