Automating generation of PDF and Webhelp from GIT

[Ron Wheeler]

An interesting reference for anyone who is looking at the issue of
generating docs and help automatically
I suppose that it could be adapted to SVN.

This might encourage developers to keep the docs in synch with the code:
- same repo and developent tools
- automatic update of documentation when code changed.

Ron

-------- Forwarded Message --------

On Thursday, 2015-09-17, at 12:58 CEST, [hidden email]
[dita-users] wrote:
> Can anyone please provide suggestions on how to implement the
> automatic generation of documents from GIT?


Hi Sonika,

I’ve given a few conference presentations on Automating DITA Builds
over the past few years. You may find this information useful as you
investigate automation options for your project.

The slides from my talk at DITA North America in Seattle last year are
available here:
<http://infotexture.net/2014/04/automating-dita-builds-seattle/>.

The presentation was expanded to an article for the CIDM Best Practices
Newsletter:
<http://infotexture.net/2014/09/best-practices-article-automating-dita-builds/>.

Both outline various automation approaches, including Git hooks and
continuous integration servers like Jenkins (as Radu suggested). Code
samples are included that you can use to trigger builds when you commit
changes to Git.

Hope that helps,

Roger


P.S.

The DITA For Small Teams project <http://www.dita-for-small-teams.org/>
is also putting together a series of sample projects and resources that
can be used to automate the build process. There has been some
discussion lately about preparing Docker containers that would provide a
pre-configured DITA-OT and Jenkins, but I’m not sure how far that idea
has come.



------------------------------------
Posted by: "Roger Sheen" <[hidden email]>
------------------------------------


------------------------------------

Yahoo Groups Links

<*> To visit your group on the web, go to:
     http://groups.yahoo.com/group/dita-users/

<*> Your email settings:
     Individual Email | Traditional

<*> To change settings online go to:
     http://groups.yahoo.com/group/dita-users/join
     (Yahoo! ID required)

<*> To change settings via email:
     [hidden email]
     [hidden email]

<*> To unsubscribe from this group, send an email to:
     [hidden email]

<*> Your use of Yahoo Groups is subject to:
     https://info.yahoo.com/legal/us/yahoo/utos/terms/

[Jacques Le Roux]

That's interesting Ron

Maybe you could put a note at in OFBIZ-6015?

Thanks

Jacques


Le 17/09/2015 21:10, Ron Wheeler a écrit :

> An interesting reference for anyone who is looking at the issue of generating docs and help automatically
> I suppose that it could be adapted to SVN.
>
> This might encourage developers to keep the docs in synch with the code:
> - same repo and developent tools
> - automatic update of documentation when code changed.
>
> Ron
>
> -------- Forwarded Message --------
>
> On Thursday, 2015-09-17, at 12:58 CEST, [hidden email]
> [dita-users] wrote:
>> Can anyone please provide suggestions on how to implement the
>> automatic generation of documents from GIT?
>
>
> Hi Sonika,
>
> I’ve given a few conference presentations on Automating DITA Builds
> over the past few years. You may find this information useful as you
> investigate automation options for your project.
>
> The slides from my talk at DITA North America in Seattle last year are
> available here:
> <http://infotexture.net/2014/04/automating-dita-builds-seattle/>.
>
> The presentation was expanded to an article for the CIDM Best Practices
> Newsletter:
> <http://infotexture.net/2014/09/best-practices-article-automating-dita-builds/>.
>
> Both outline various automation approaches, including Git hooks and
> continuous integration servers like Jenkins (as Radu suggested). Code
> samples are included that you can use to trigger builds when you commit
> changes to Git.
>
> Hope that helps,
>
> Roger
>
>
> P.S.
>
> The DITA For Small Teams project <http://www.dita-for-small-teams.org/>
> is also putting together a series of sample projects and resources that
> can be used to automate the build process. There has been some
> discussion lately about preparing Docker containers that would provide a
> pre-configured DITA-OT and Jenkins, but I’m not sure how far that idea
> has come.
>
>
>
> ------------------------------------
> Posted by: "Roger Sheen" <[hidden email]>
> ------------------------------------
>
>
> ------------------------------------
>
> Yahoo Groups Links
>
> <*> To visit your group on the web, go to:
>     http://groups.yahoo.com/group/dita-users/
>
> <*> Your email settings:
>     Individual Email | Traditional
>
> <*> To change settings online go to:
>     http://groups.yahoo.com/group/dita-users/join
>     (Yahoo! ID required)
>
> <*> To change settings via email:
>     [hidden email]
>     [hidden email]
>
> <*> To unsubscribe from this group, send an email to:
>     [hidden email]
>
> <*> Your use of Yahoo Groups is subject to:
>     https://info.yahoo.com/legal/us/yahoo/utos/terms/
>
>
>
>
>

[Jacques Le Roux]

Or rather OFBIZ-6644 now

Le 21/09/2015 10:06, Jacques Le Roux a écrit :

> That's interesting Ron
>
> Maybe you could put a note at in OFBIZ-6015?
>
> Thanks
>
> Jacques
>
>
> Le 17/09/2015 21:10, Ron Wheeler a écrit :
>> An interesting reference for anyone who is looking at the issue of generating docs and help automatically
>> I suppose that it could be adapted to SVN.
>>
>> This might encourage developers to keep the docs in synch with the code:
>> - same repo and developent tools
>> - automatic update of documentation when code changed.
>>
>> Ron
>>
>> -------- Forwarded Message --------
>>
>> On Thursday, 2015-09-17, at 12:58 CEST, [hidden email]
>> [dita-users] wrote:
>>> Can anyone please provide suggestions on how to implement the
>>> automatic generation of documents from GIT?
>>
>>
>> Hi Sonika,
>>
>> I’ve given a few conference presentations on Automating DITA Builds
>> over the past few years. You may find this information useful as you
>> investigate automation options for your project.
>>
>> The slides from my talk at DITA North America in Seattle last year are
>> available here:
>> <http://infotexture.net/2014/04/automating-dita-builds-seattle/>.
>>
>> The presentation was expanded to an article for the CIDM Best Practices
>> Newsletter:
>> <http://infotexture.net/2014/09/best-practices-article-automating-dita-builds/>.
>>
>> Both outline various automation approaches, including Git hooks and
>> continuous integration servers like Jenkins (as Radu suggested). Code
>> samples are included that you can use to trigger builds when you commit
>> changes to Git.
>>
>> Hope that helps,
>>
>> Roger
>>
>>
>> P.S.
>>
>> The DITA For Small Teams project <http://www.dita-for-small-teams.org/>
>> is also putting together a series of sample projects and resources that
>> can be used to automate the build process. There has been some
>> discussion lately about preparing Docker containers that would provide a
>> pre-configured DITA-OT and Jenkins, but I’m not sure how far that idea
>> has come.
>>
>>
>>
>> ------------------------------------
>> Posted by: "Roger Sheen" <[hidden email]>
>> ------------------------------------
>>
>>
>> ------------------------------------
>>
>> Yahoo Groups Links
>>
>> <*> To visit your group on the web, go to:
>>     http://groups.yahoo.com/group/dita-users/
>>
>> <*> Your email settings:
>>     Individual Email | Traditional
>>
>> <*> To change settings online go to:
>>     http://groups.yahoo.com/group/dita-users/join
>>     (Yahoo! ID required)
>>
>> <*> To change settings via email:
>>     [hidden email]
>>     [hidden email]
>>
>> <*> To unsubscribe from this group, send an email to:
>>     [hidden email]
>>
>> <*> Your use of Yahoo Groups is subject to:
>>     https://info.yahoo.com/legal/us/yahoo/utos/terms/
>>
>>
>>
>>
>>
>