#2727 Docs draft build environment
Closed: Fixed None Opened 13 years ago by jjmcd.

= problem =

Doc produces nightly drafts for L10N during translation. However, not all docs contributors have boxes that run 24/7 and for them running cron jobs is problematic. Sometimes, too, a contributor goes out of town and forgets that his laptop is providing nightly service to L10N.

= analysis =

A home on the infrastructure could provide a consistent environment.

Benefits:
* Provide drafts for all docs to L10N
* Ensure consistency in how drafts are provided
* Avoid each contributor having to reinvent the wheel
* Avoid outages caused by contributor events

= enhancement recommendation =

Provide a place where a nightly cron job, for each document, would:

  • clone the source
  • copy the xml to the translation branch
  • pull from tx
  • build the html
  • move the result to fedorapeople.org/groups/docs or otherwise make the result available to L10N

Additional benefits could be gained by also providing the ability to publish to docs.fp.o. Slightly different but very similar process, and not nearly as frequent.


I'll be infra sponsor for this.

So, this sounds to me like a public test box would be the first/easiest step?

ie, set it up and get everything working as you need (and use it for now), then once it's all working, merge that work into production (ie, could this eventually go on the bapp servers or the like?).

I agree that a pt box makes sense for now, and eventually we would like to move to the bapp servers. We would just need a way for members of the docs-publishers group to move particular built RPMs into a repo where the web server can find and install them. The most obvious (to me) way to do this is to allow members of that group to copy .rpm files from the rpmbuild/RPMS/noarch directory on that machine to whatever directory is set up as a docs repo.

Ideally, we should be doing this on an EL6 box, so that we can install the built documentation RPMs on another EL6 box, and have docs.fedoraproject.org point to that machine's web root.

I have EL6 scratch builds here:
http://koji.fedoraproject.org/koji/taskinfo?taskID=2998628

So:

Immediate use case:
1. cronjob checks out latest versions of docs sources from fedorahosted
3. cronjob builds documentation packages
4. cronjob localinstalls documentation packages onto this machine
5. docs and L10N proofreaders can inspect the docs

Future use case:
6. docs publishers copy known good RPMs to a repo
7. docs.fedoraproject.org webserver installs RPMs from that repo and serves them to the world

I've setup publictest01.fedoraproject.org for this.

Please let me know if it doesn't meet your needs.

Once you have scripts all setup and working as you like, we can look at moving this into stg and then production. In the mean time I hope it will help with your translators. ;)

Re-open if you need anything.

Login to comment on this ticket.

Metadata