Feature #10792

Try to group inc/steps inlines

Added by sajolida 2015-12-23 06:30:16 . Updated 2016-03-19 20:14:27 .

Status:
Resolved
Priority:
Normal
Assignee:
Category:
Installation
Target version:
Start date:
2015-12-23
Due date:
% Done:

0%

Feature Branch:
web/10792-group-ia-inlines
Type of work:
End-user documentation
Blueprint:

Starter:
Affected tool:
Installation Assistant
Deliverable for:

Description

Pages with many inlines are slower to build by ikiwiki. Now that the set of scenarios and steps is clear, it might be worth checking whether some sequences of steps are always the same and could be grouped in a single page.

Subtasks

History

#1 Updated by sajolida 2016-01-16 16:28:56

  • Target version changed from Tails_2.0 to Tails_2.2
  • Parent task deleted (Feature #8592)

Let’s say this is a bonus and not a blocker for the first release.

#2 Updated by sajolida 2016-02-13 14:36:39

  • Description updated

Maybe they could be identified by:

  • Listing all inlines in the assistant:
cd wiki/src/install
find -iname "*.inline.*m*"
  • Check what each occurrence of them has before and after:
git grep -B 3 -A 3 restart_first_time.inline -- "*.*m*"
  • If InlineA always happens before InlineB, then check whether InlineB always happens after InlineA. If so, then they can be grouped.

#3 Updated by sajolida 2016-02-21 20:29:59

#4 Updated by sajolida 2016-02-21 21:27:51

Results are that we can get rid of 3 inlines out of 18 by moving:

  • you_are_done at the beginning of create_persistence
  • switch at the beginning of restart_first_time
  • not_entirely in restart_first_time

#5 Updated by sajolida 2016-02-22 07:18:04

  • Assignee changed from sajolida to spriver
  • Feature Branch set to web/10792-group-ia-inlines

Done in web/10792-group-ia-inlines.

spriver: do you mind having a look or shall I rather ask intrigeri?

#6 Updated by sajolida 2016-02-22 08:16:29

Gain in build speed is 4% :)

#7 Updated by spriver 2016-02-22 08:29:21

I’ll have a look on this this tonight. I’ll ask if there are questions ;)

#8 Updated by intrigeri 2016-02-22 21:07:27

Also, it seems that:

  • inc/router/why_extra.inline is used only in upgrade.html, so perhaps it could be inlined (ah ah) there directly
  • inc/steps/bittorrent_verification.inline is used only in install/inc/steps/download.inline.html

Spotted with this command-line, that I barely dare sharing given how weak it is:

for inline in $(find install/ -iname "*.inline.*m*" | perl -p -E 's,^install/,,; s,\.(?:html|mdwn)$,,')  ; do echo "$inline : " ; git grep -c -E "\[\[\!inline.*$inline" **/*.*m* | sed -e 's,^,  ,' ; done

#9 Updated by spriver 2016-02-22 22:16:09

  • Assignee changed from spriver to sajolida
  • QA Check set to Info Needed

I reviewed sajolida’s changes, I did not find any problems so far (as far as I can see that, I’m quite new to the structure of the Installation Assistant, but I checked the changed pages and they’re okay and the changes seem reasonable and comprehensive for me)

Regarding to intrigeri’s proposal, maybe we could also inline where only two occurrences happen. IMHO this would be okay for translators (from my perspective).

Another thing: is this on purpose that the link on wiki/src/install/expert/usb pointing to the website (section “Open these instructions on another device”) is not in the same style as on the other pages (e.g. wiki/src/install/debian/usb). I’d also love to see the Debian/Ubuntu icon similarly to wiki/src/install/debian/usb on wiki/src/install/expert/usb in the very first section.

#10 Updated by sajolida 2016-02-24 15:24:06

> * inc/router/why_extra.inline is used only in upgrade.html

It is meant to be used on /install/inc/overview.html as well but this
was breaking the layout on boum.org only for some paranormal reason, so
I disabled it temporarily in 82b0cbf and should be fixed by Bug #10793.

> * inc/steps/bittorrent_verification.inline is used only in install/inc/steps/download.inline.html

Yes, it’s used on a single page but three times for different contexts.

So I think we’re fine and I’m glad you double-checked my work so carefully!

#11 Updated by sajolida 2016-02-24 15:30:18

> I reviewed sajolida’s changes […] (and they) seem reasonable and comprehensive for me)

Thanks!

So can I merge?

> […] maybe we could also inline where
> only two occurrences happen. IMHO this would be okay for translators
> (from my perspective).

Hmm… I’m not sure speeding up the big by a few seconds is worth
duplicating strings and adding maintenance.

About the link on /install/expert/usb, this scenario is the only one
that doesn’t have bootstrap enabled. tchou introduced quite a few
inconsistencies in style between the base site, assistant pages with
bootstrap, and assistant pages without bootstrap. I removed some but I
don’t have the time and energy to go further right now. Feel free to
propose patch for some of these glitches and I’d be super happy to merge
them.

#12 Updated by sajolida 2016-02-24 16:04:53

  • Assignee changed from sajolida to intrigeri
  • QA Check changed from Info Needed to Ready for QA

#13 Updated by intrigeri 2016-02-25 22:37:13

  • Assignee changed from intrigeri to sajolida

I likely won’t have time to work on this during the 2.2 cycle, so if this is the desired time frame, please try to find someone else. Otherwise, just adjust the target version to 2.3+ and reassign to me :)

#14 Updated by sajolida 2016-03-07 15:13:11

  • Target version deleted (Tails_2.2)

#15 Updated by sajolida 2016-03-19 20:14:27

  • Status changed from Confirmed to Resolved
  • Assignee deleted (sajolida)
  • QA Check deleted (Ready for QA)

spriver already reviewed and acked. You were the one to raised concerns and I think I answered all of them without having to do more commits. So I’ll merge.