Opened on 09/02/2014 at 09:02:56 AM

Closed on 02/09/2016 at 01:41:42 PM

Last modified on 02/09/2016 at 04:30:09 PM

#1299 closed change (fixed)

Generate docs outside the devbuild build process

Reported by: fhd Assignee: fhd
Priority: P2 Milestone:
Module: Sitescripts Keywords:
Cc: trev, sebastian Blocked By: #116
Blocking: #3621, #3637 Platform: Unknown
Ready: yes Confidential: no
Tester: Unknown Verified working: no
Review URL(s):

http://codereview.adblockplus.org/5396204603047936/ (Abandoned)
https://codereview.adblockplus.org/29335805/

Description (last modified by fhd)

Background

We are currently generating the docs for adblockplus and adblockpluschrome in createNightlies.py, i.e. as part of the devbuild build process. That's not the best place for it, because we also need to generate docs for libadblockplus and adblockpluscore (see #3618).

What to change

Trigger doc generation through a separate cron job or post-receive hook, not through createNightlies.py. This should generate docs for adblockplus, adblockpluschrome, adblockpluscore, and libadblockplus (https://adblockplus.org/docs/libadblockplus/).

Things to consider:

  1. We should use hg archive to clone the repositories, it's faster.
  2. We shouldn't remove the clones after the script, but keep it around and update it instead.
  3. We should keep the clone on the same volume as the target dir (i.e. /srv) to ensure the mv is fast enough.
  4. We should move the target docs dir and replace it before removing it - will reduce docs downtime.

Attachments (0)

Change History (18)

comment:1 Changed on 09/02/2014 at 09:03:08 AM by fhd

  • Blocked By 116 added

comment:2 Changed on 09/02/2014 at 02:04:48 PM by fhd

  • Review URL(s) modified (diff)
  • Status changed from new to reviewing

comment:3 Changed on 09/02/2014 at 03:23:19 PM by fhd

  • Status changed from reviewing to reopened

Reopening, the approach in the review was too hacky. We should do this in sitescripts.

Notes from the review:

  1. We should use hg archive for the clone, it's faster.
  2. We shouldn't remove the clone after the script, but keep it around and update it instead.
  3. We should keep the clone on the same volume (i.e. /srv) to ensure the mv is fast enough.
  4. We should move the target docs dir and replace it before removing it - will reduce docs downtime.

comment:4 Changed on 09/02/2014 at 03:32:54 PM by fhd

  • Description modified (diff)

comment:5 Changed on 09/16/2014 at 07:52:29 PM by trev

  • Priority changed from P2 to P4

comment:6 Changed on 02/19/2015 at 01:40:49 PM by sebastian

  • Component changed from Infrastructure to Sitescripts

comment:7 Changed on 02/03/2016 at 12:26:21 PM by fhd

  • Cc sebastian added
  • Description modified (diff)
  • Priority changed from P4 to P2
  • Tester set to Unknown

This is getting important now, because we also need it for the adblockpluscore documentation.

comment:8 Changed on 02/03/2016 at 12:27:11 PM by fhd

  • Blocking 3621 added

comment:9 Changed on 02/03/2016 at 12:38:53 PM by fhd

  • Summary changed from Generate the libadblockplus API documentation on adblockplus.org to Generate docs outside the devbuild build process

comment:10 Changed on 02/03/2016 at 01:01:47 PM by fhd

  • Owner set to fhd

comment:11 Changed on 02/05/2016 at 05:12:03 PM by fhd

  • Review URL(s) modified (diff)
  • Status changed from reopened to reviewing

comment:12 Changed on 02/06/2016 at 10:35:02 AM by sebastian

  • Blocked By 3635 added

comment:13 Changed on 02/06/2016 at 08:26:45 PM by fhd

  • Blocking 3637 added

comment:14 follow-up: Changed on 02/06/2016 at 08:31:17 PM by fhd

Sebastian: I don't think #3635 should block this one. Even if we change ensure_dependencies.py, we cannot update it in ABP for Firefox since that one is still in code freeze until #3621 lands, which is blocked by this issue here. I think we should land this here first, then fix #3635, then remove the hack introduced here.

BUT: I just realised we have to run this on server16 if we stick to the hg archive (see #3637), which is bad. So I think it would be best to just use hg clone and hg update in this script, that would make #3635 irrelevant here. What do you think?

comment:15 Changed on 02/09/2016 at 11:30:37 AM by sebastian

  • Blocked By 3635 removed

comment:16 in reply to: ↑ 14 Changed on 02/09/2016 at 11:32:47 AM by sebastian

Replying to fhd:

Sebastian: I don't think #3635 should block this one. Even if we change ensure_dependencies.py, we cannot update it in ABP for Firefox since that one is still in code freeze until #3621 lands, which is blocked by this issue here. I think we should land this here first, then fix #3635, then remove the hack introduced here.

I agree. When I first triaged #3635 I assumed that we are still going to use hg archive but rather want to update the repositories than going with the workaround. I updated the issue.

comment:17 Changed on 02/09/2016 at 01:41:42 PM by fhd

  • Resolution set to fixed
  • Status changed from reviewing to closed

comment:18 Changed on 02/09/2016 at 04:30:09 PM by fhd

Add Comment

Modify Ticket

Change Properties
Action
as closed .
The resolution will be deleted. Next status will be 'reopened'.
to The owner will be changed from fhd.
 
Note: See TracTickets for help on using tickets.