Page 1 of 1

Build oxygen webhelp automatically

Posted: Fri Apr 24, 2020 10:16 am
by catherine
Hi,
I am considering the oxygen webhelp plugin to acheive automatic generation of webhelp after each commit.

I have a question:
If I uses Github as my git server to store my dita files, map files, etc. , is there any way to build webhelp in the Github and automatically transmit the webhelp output to another server, for example, my website server?

Or should I set my website server as git server?

Actually, I have few knowledge of the webhelp pugin, I don't know how to make it work automatically and continuously.

For now, we generate webhelp in our local PC and transmit all webhelp files to our website, which is a heavy and inefficient work if we update our documentation continually.

Thanks and Regards,
Catherine

Re: Build oxygen webhelp automatically

Posted: Tue Apr 28, 2020 10:00 am
by ionela
Hi Catherine,

You can automate the WebHelp Responsive output generation from an automatic publishing system.
In our user manual you can find more details about how you can generate the WebHelp Responsive output from a integration server (Travis/Jenkins):
Generating WebHelp Responsive Output - Running from an Integration Server

Let us know if you need further assistance.

Regards,
Ionela

Re: Build oxygen webhelp automatically

Posted: Sat May 09, 2020 8:34 am
by catherine
Hi, Ionela
Thanks for your help!
For now, we store all the dita files, css files, js files etc. in a public github repository, and publish webhelp and pdf files in our local pc, then we send the webhelp output and pdf files to our website server.

I am trying to figure out how we can build the webhelp automatically.
should we set up another server as a publishing server, which helps us build webhelp automatically´╝č

By the way, we are also considering oxygen web author, which is the best place that we deploy the web author?


Regards,
Catherine

Re: Build oxygen webhelp automatically

Posted: Mon May 11, 2020 3:28 pm
by ionela
Hi Catherine,

I think this procedure from our use manual suits to your use-case. You can try to automate the WebHelp Responsive generation using Travis CI:
Automating DITA to WebHelp Responsive Output with Travis CI

Regards,
Ionela

Re: Build oxygen webhelp automatically

Posted: Tue May 12, 2020 12:45 pm
by catherine
Hi, Ionela
Thanks for you help.
Yesterday, I removed the public repository from github, and now our source files are now stored in private repository in the local GitLab.

We have an existing website and have our domain.
I find that the GitLab CI is a little bit different from the Github CI and GitLab pages.
We need to build webhelp automatically from the GitLab to our existing website.
Is that possible?

Best Regards,
Catherine

Re: Build oxygen webhelp automatically

Posted: Fri May 15, 2020 1:43 pm
by ionela
Hi Catherine,

Unfortunately, we do not have experience with GitLab CI.
But, as WebHelp Responsive can be run from the command line, if the integration server you've mentioned offers support to run the output generation script you can try to automate the publishing process using it.

Regards,
Ionela

Re: Build oxygen webhelp automatically

Posted: Fri May 15, 2020 6:34 pm
by catherine
Thanks, ionela
I'm learning Jenkins, and try to build the webhelp by Jenkins.
I've searched Oxygen forum and found the build architecture.

The following is the build architecture, can you check it is correct or not?
  • Version control system GitLab: stores all of our doc sources, like dita, css, js, etc.
  • Publishing Server: has jenkins + DITAOT+ Oxygen Webhelp puglin installed and integrated
  • Website server: this remote server stores the webhelp output files which is delivered from the publishing server automatically by jenkins
I'm trying to deploy the publishing server following by your documents:
https://www.oxygenxml.com/doc/versions/ ... aid-title4

Actually, this document is hard for me, who never knew jenkins before.
If you have a tutorial or an example configuration for a naive user to start with, that will be perfect.

Best Regards,
Catherine

Re: Build oxygen webhelp automatically

Posted: Tue May 19, 2020 12:47 pm
by Costin
Hi Catherine,

I'm afraid that we do not have any guidelines to start up with using Jenkins or other CI systems.
Also, we only develop Oxygen products and can help with issues related strictly to using them, but we do not offer any training or consultancy services.

We suggest you should reach to a company specialized in such services, that could provide in-depth assistance. There is a list of training/consultancy companies on our website so I though it might be worth taking a look at it - it might help you find a training/consultancy company to get you started with publishing using continuous integration systems.

Best Regards,
Costin

Re: Build oxygen webhelp automatically

Posted: Tue May 19, 2020 12:58 pm
by catherine
Hi, Costin
Thanks for your tips! :wink:

Best Regards,
Catherine