topic Build Activiti Userguide in Alfresco Archive

Build Activiti Userguide

vickysirwani — Wed, 23 Jul 2014 10:03:25 GMT

How do I build the user guide present in activiti git repo for local usage?

Re: Build Activiti Userguide

jbarrez — Fri, 25 Jul 2014 08:06:15 GMT

That is still an ant script.

in the distro folder: 'ant clean build.docs'

Note that this will fail the first time, a message in the logs will indicate what you have to install first to fix it.

Re: Build Activiti Userguide

lsmall — Mon, 30 Mar 2015 17:40:01 GMT

I have not been able to successfully build the user guide either. I installed asciidocs as per the readme:

Tooling
——-

Install Asciidoctor: http://asciidoct./generate-html
or.org/

We're using the 'pygments' library for syntax highlighting. This needs to be installed: gem install pygments.rb

When I tried to install pygments, I get the following error:
ERROR: Error installing pygments.rb:
        ERROR: Failed to build gem native extension.

    C:/jruby-1.7.18/bin/jruby.exe extconf.rb
C:/jruby-1.7.18/lib/ruby/shared/mkmf.rb:14: Use RbConfig instead of obsolete and deprecated Config.
mkmf.rb can't find header files for ruby at C:/jruby-1.7.18/lib/native/include/ruby/ruby.h

Gem files will remain installed in C:/jruby-1.7.18/lib/ruby/gems/shared/gems/yajl-ruby-1.2.1 for inspection.
Results logged to C:/jruby-1.7.18/lib/ruby/gems/shared/gems/yajl-ruby-1.2.1/ext/yajl/gem_make.out

I have googled and tried multiple versions of ruby/jruby, etc. with no luck. When I attempt to build the user guide, I still get this error:
C:\Users\lsmall\git\Activiti\distro\build.xml:148: The following error occurred while executing this line:
C:\Users\lsmall\git\Activiti\userguide\build.xml:12: Execute failed: java.io.IOException: Cannot run program "asciidoctor" (in directory "C:\Users\lsmall\git\Activiti\userguide\src\en"): CreateProcess error=2, The system cannot find the file specified
        at java.lang.ProcessBuilder.start(ProcessBuilder.java:470)
…

Can you please advise? I hope to contribute to the User Guide in the future and would like to be able to test my changes prior to generating pull requests.

Re: Build Activiti Userguide

lsmall — Mon, 30 Mar 2015 17:55:07 GMT

I updated the user guide build.xml file to reference the asciidoctor.bat file on line 12 and was able to proceed beyond the IOException, but still could not find the pygments.rb componennt:

build.html:
     [exec] asciidoctor: FAILED: required gem 'pygments.rb' is not installed. Processing aborted. (RuntimeError)
     [exec]   Use –trace for backtrace
     [exec] Result: 1
     [copy] Copying 194 files to C:\Users\lsmall\git\Activiti\userguide\target\html\en

build.userguide:
    [mkdir] Created dir: C:\Users\lsmall\git\Activiti\distro\target\zip\activiti-5.17.1-SNAPSHOT\docs\userguide
     [copy] Copying 194 files to C:\Users\lsmall\git\Activiti\distro\target\zip\activiti-5.17.1-SNAPSHOT\docs\userguide

Re: Build Activiti Userguide

jbarrez — Tue, 31 Mar 2015 09:06:43 GMT

Hi Lori,

See the docs at https://github.com/Activiti/Activiti/tree/master/userguide/src/en

Re: Build Activiti Userguide

lsmall — Tue, 31 Mar 2015 12:49:47 GMT

Can you be more specific? I have seen the readme and attempted to install asciidocs and pyments. What did I miss? Has anyone successfully built in a Windows 7 Enterprise environment?

Re: Build Activiti Userguide

trademak — Wed, 01 Apr 2015 12:15:01 GMT

Hi Lori,

Did you install Python? When I search for the error message it shows that as part of the solution.
We all use macbooks, so not really familiar with the specifics to build it on Windows, I'm afraid.

Best regards,

Re: Build Activiti Userguide

lsmall — Wed, 01 Apr 2015 12:45:32 GMT

Yes, I did, but I will keep trying to find the combination that works on Windows. I tried both Python 2.7 and 3.4. Thanks!