Guten Tag Alexandru Zbarcea,
am Dienstag, 7. Januar 2014 um 20:24 schrieben Sie:

> There should be a script that updates the site with the latest
> documentation, and this should be done by the Promotion step when we
> decide a new version may be delivered.

As far as I understood the explanation about the project sites, the
site needs to be generated and afterwards committed to a special repo
to get published. We don't have access to that repo currently, I tried
and couldn't even read.

But as Rhys said, my "problem" currently is that we have manually
edited usage texts as part of the project site which links to
automatically generated apidocs contents and those targets may or may
not change unrecognized.

Maybe we are able to implement some logic in the build scripts to
finally create the links to the targets by searching the created files
in apidocs for some semi unique keys, but I'm currently not sure if
it's really worth the effort.

> This is the reason of the
> automation task using "nightly builds", using the #jenkins ASF etc. 

This wouldn't work right now for automatic publishment of the site
because we simply don't have access to the repo were the generated
sites are hosted. From my opinion we shouldn't focus on this anyways,
if we can use Jenkins to run useful tests that would be enough for
quite some time. Nightly builds which aren't used because of missing
user base or interest won't be of much help. :-)

> What is your opinion on that? Should we consider from now on, as
> rule of thumb, that NEVER we should put generated code on the VCS?

For easy things or those contents that are easy to generate, maybe
like the project site and apidocs currently, I agree. But if we don't
have a proper build process for some contents or it doesn't work for
some used platforms or compilers, we should decide case by case,
depending on needed space and all such stuff. Subversion is quite good
to even store binary data, I have some repos only for binary
distributions of our software for example and if it makes user's life
easier...

Mit freundlichen Grüßen,

Thorsten Schöning

-- 
Thorsten Schöning       E-Mail:[email protected]
AM-SoFT IT-Systeme      http://www.AM-SoFT.de/

Telefon...........05151-  9468- 55
Fax...............05151-  9468- 88
Mobil..............0178-8 9468- 04

AM-SoFT GmbH IT-Systeme, Brandenburger Str. 7c, 31789 Hameln
AG Hannover HRB 207 694 - Geschäftsführer: Andreas Muchow

Reply via email to