Translated installation guide fails to build

[Łukasz Jernaś]

Translated installation guides fail to build with
[deejay1@betty install-guide]$ mvn clean generate-sources
[INFO] Scanning for projects...
[ERROR] The build could not read 1 project -> [Help 1]
[ERROR]
[ERROR] The project org.openstack.docs:openstack-install-guide:1.0.0-SNAPSHOT (/home/deejay1/PRACA/cloud/openstack-manuals/generated/pl_PL/install-guide/pom.xml) has 1 error
[ERROR] Non-resolvable parent POM: Could not find artifact org.openstack.docs:parent-pom:pom:1.0.0-SNAPSHOT and 'parent.relativePath' points at wrong local POM @ line 4, column 13 -> [Help 2]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/ProjectBuildingException
[ERROR] [Help 2] http://cwiki.apache.org/confluence/display/MAVEN/UnresolvableModelException

Log fron jenkins: https://jenkins02.openstack.org/job/openstack-install-deploy-guide-ubuntu-ja/21/console

Changing parent.relativePath doesn't do much either, as it results in

[deejay1@betty install-guide]$ LC_ALL=C mvn clean generate-sources
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building OpenStack Installation Guide 1.0.0-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ openstack-install-guide ---
[INFO] Deleting /home/deejay1/PRACA/cloud/openstack-manuals/generated/pl_PL/install-guide/target
[INFO]
[INFO] --- clouddocs-maven-plugin:1.13.0:generate-webhelp (generate-webhelp) @ openstack-install-guide ---
[INFO] Processing input file: bk_openstackinstallguide.xml
[WARNING] Property not found in com.agilejava.docbkx.maven.DocbkxWebhelpMojo
[WARNING] Property not found in com.agilejava.docbkx.maven.DocbkxWebhelpMojo
[error] jar:file:/home/deejay1/.m2/repository/com/rackspace/cloud/api/clouddocs-maven-plugin/1.13.0/clouddocs-maven-plugin-1.13.0.jar!/pdf.xpl:99:62:XInclude resource error (../common/section_dochistory.xml) and no fallback provided.
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 6.342s
[INFO] Finished at: Sat Feb 01 18:47:56 CET 2014
[INFO] Final Memory: 24M/210M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal com.rackspace.cloud.api:clouddocs-maven-plugin:1.13.0:generate-webhelp (generate-webhelp) on project openstack-install-guide: Execution generate-webhelp of goal com.rackspace.cloud.api:clouddocs-maven-plugin:1.13.0:generate-webhelp failed: XInclude resource error (../common/section_dochistory.xml) and no fallback provided. XProc error err:XD0011: I/O error reported by XML parser processing file:/home/deejay1/PRACA/cloud/openstack-manuals/generated/pl_PL/common/section_dochistory.xml: /home/deejay1/PRACA/cloud/openstack-manuals/generated/pl_PL/common/section_dochistory.xml (No such file or directory) -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/PluginExecutionException

[Anne Gentle (annegentle)]

It looks like you're missing a file or two:
1. do you have the entire openstack-manuals directory structure? Then it can find the root pom.xml in addition to the pom.xml in the install-guide directory.
2. Can you make sure your doc/common/ directory is also there and reachable from the install-guide directory? There are some files in there that the install-guide needs as well.

I think if you get the entire openstack-manuals directory and try again you'll be able to build the install guide from within the install-guide directory in any language, but do let us know how it goes.

[Łukasz Jernaś (deejay1)]

I tried an empty checkout to no avail, also you can see that the jenkins jobs are failing.
It seems that the build steps will need to be updated because I managed to build the guide after completing the following steps:

./tools/generatedocbook -l pl_PL -b glossary
./tools/generatedocbook -l pl_PL -b common
./tools/generatedocbook -l pl_PL -b user-guide
./tools/generatedocbook -l pl_PL -b install-guide

Updating the relativePath in install-guide/pom.xml

(also it doesn't matter if I take the generaqtedocbook from the repo or the tools repo)

So it seems that the Japanese jenkins job will have to be updated also with additional steps, unfortunately I'm unable to look at it today but I hope to get it done tomorrow

[Łukasz Jernaś (deejay1)]

Of course copying the POM over also works...

[Łukasz Jernaś (deejay1)]

I've proposed changes to the build process for now, but IMHO it requires some support from the generatedocbook script...

Gerrit: https://review.openstack.org/#/c/70574/

[Andreas Jaeger (jaegerandi)]

Let me handle this a bit differently.

[Andreas Jaeger (jaegerandi)]

I suggest to handle this with openstack-doc-tools 0.5 and running "tox -e buildlang -- $LANG"

Patch for ops guide to do this here:
https://review.openstack.org/#/c/71056/

Patch for openstack-manuals will follow once 71056 is in.

[Łukasz Jernaś (deejay1)]

Won't this build the wrong guide now? As far as I can see this patch addresses the OPS guide not the install manual.

If you plan to change tox.ini in openstack-manuals then that patch should go before the jenkins one IMO, because right now for openstack-ops you'll be guilding the install guide

[Andreas Jaeger (jaegerandi)]

Please reread comment #7.

Yes, my patch is for the ops guide. I will do a similar patch for openstack-manuals. The patch for the tox file for openstack-manuals is already in.

You can already (in since 12 hours) run "tox -e buildlang pl" to build the polish manuals if you like.

[Łukasz Jernaś (deejay1)]

Andreas, I did read it 3 times. My point was that the OPS patch builds the install manual not the ops guide as the tox patch is in

tox.ini in master branch:
[testenv:buildlang]
# Run as "tox -e buildlang -- $LANG"
commands =
  generatedocbook -l {posargs} -b common
  generatedocbook -l {posargs} -b glossary
  generatedocbook -l {posargs} -b user-guide
  generatedocbook -l {posargs} -b install-guide
  cp doc/pom.xml generated/{posargs}/pom.xml
  openstack-doc-test --check-build -l {posargs} --only-book install-guide
                                                                                           ^^^^^^^^^^^^^^^^^^^^

Ops guide build call in https://review.openstack.org/#/c/71056/ :
tox -v -e buildlang -- {lang}

[Andreas Jaeger (jaegerandi)]

operations-guide has:

[testenv:buildlang]
# Run as "tox -e buildlang -- $LANG"
commands =
   generatedocbook -l {posargs} -b openstack-ops
   openstack-doc-test --check-build -l {posargs}

openstack-manuals has:
[testenv:buildlang]
# Run as "tox -e buildlang -- $LANG"
commands =
  generatedocbook -l {posargs} -b common
  generatedocbook -l {posargs} -b glossary
  generatedocbook -l {posargs} -b user-guide
  generatedocbook -l {posargs} -b install-guide
  cp doc/pom.xml generated/{posargs}/pom.xml
  openstack-doc-test --check-build -l {posargs} --only-book install-guide

So, for both guides, "tox -v -e buildlang -- {lang}" should do the right thing. Or what am I missing?

Btw. feel free to catch me on openstack-doc IRC to discuss further.

[Łukasz Jernaś (deejay1)]

Shame on me, I forgot that the ops-guide was in a seperate repo. I'm so sorry Andreas for the confusion :(

[Andreas Jaeger (jaegerandi)]

Łukasz, no problem. Glad to see this confusion resolved.

[Andreas Jaeger (jaegerandi)]

This is fixed now.

[Andreas Jaeger (jaegerandi)]

Nearly fixed, needs one more small change.

[Łukasz Jernaś (deejay1)]

Andreas, can you make it so that the output from maven is in the build output? Right now openstack-doc-tools is hiding bugs in the builds :(

[Łukasz Jernaś (deejay1)]

OK, it's output on errors, nvm (again ;)

[Andreas Jaeger (jaegerandi)]

0.7.0 should output errors but I haven't tested all errors, if there's something that's not reported in the log files, please tell me.

[Andreas Jaeger (jaegerandi)]

This is done now correctly using tox and openstack-doc-tools in the Jenkins jobs.