Tails

#1 Updated by spriver 2016-01-14 11:14:58

• Feature Branch set to spriver:doc/10934-reset-linux

#2 Updated by sajolida 2016-01-15 15:56:42

• File trailing.png added
• Assignee changed from sajolida to spriver
• QA Check changed from Ready for QA to Info Needed

Thanks for the branch. It’s good to see more people writing doc!

Here are some first comments regarding the methodology:

• You had config/base_branch set to “devel” so I guess you branched
  this out of devel. Now that RC1 has been release, you should branch
  your stuff from testing instead. I know this branch dance is
  complicated :)
• Beware of trailing white spaces, see attachment. I highly recommend
  configure your Git to display colors by default. See Bug #9130#note-12.
• When rewritting anchors like you did for id=“disk_utility” we should
  keep in mind that this might break external links. But here it’s the
  first one on the page so I think it’s no problem if we break any and
  you already fixed the only one inside tails.boum.org. So that’s
  great.

Then regarding the content, why did you choose to document formatting the first partition only (through the double-gear button) and not formatting the whole disk (through the single-gear button)? I think formatting the whole disk would be a closer equivalent to the instructions we had previously?

Regarding the style to refer to these menus with icons (I hate them!), have a look at what we did for the installations instructions for Linux where we use Disks already:

https://tails.boum.org/install/linux/usb/

There we felt the need to put a screenshot of where the button was because some users mistook it for the “double-gear” and got into serious troubles. I’m not sure we should put the same screenshot in your doc but still reuse the same way of referring to this button.

I’m also going to ask GNOME for recommendations about this. I’ll keep you updated :)

#4 Updated by spriver 2016-01-15 17:28:21

• Assignee changed from spriver to sajolida

sajolida wrote:
> Thanks for the branch. It’s good to see more people writing doc!
>
> Here are some first comments regarding the methodology:
>
> * You had config/base_branch set to “devel” so I guess you branched
> this out of devel. Now that RC1 has been release, you should branch
> your stuff from testing instead. I know this branch dance is
> complicated :)
Okay, I didn’t knew ;) but as intrigeri said I can keep it this way for this time?

> * Beware of trailing white spaces, see attachment. I highly recommend
> configure your Git to display colors by default. See Bug #9130#note-12.
Did it. Thanks for the tip (:

> * When rewritting anchors like you did for id=“disk_utility” we should
> keep in mind that this might break external links. But here it’s the
> first one on the page so I think it’s no problem if we break any and
> you already fixed the only one inside tails.boum.org. So that’s
> great.
Got it. How can I find out about the external links? For our doc I can refer to the “Pages linking to this one”?

> Then regarding the content, why did you choose to document formatting the first partition only (through the double-gear button) and not formatting the whole disk (through the single-gear button)? I think formatting the whole disk would be a closer equivalent to the instructions we had previously?
I honestly do not know why I chose to document it this way. Maybe I was thinking that some users would like to keep other partitions (e.g. persistent storage or LUKS partitions in general) I can of course change it to formatting the whole drive.

> Regarding the style to refer to these menus with icons (I hate them!), have a look at what we did for the installations instructions for Linux where we use Disks already:
>
> https://tails.boum.org/install/linux/usb/
>
> There we felt the need to put a screenshot of where the button was because some users mistook it for the “double-gear” and got into serious troubles. I’m not sure we should put the same screenshot in your doc but still reuse the same way of referring to this button.

This is probably a good idea. IMHO the new UI is not really doc friendly. I can redo the screenshot, I’ll be doing all Disks screenshots in the next days.

#5 Updated by spriver 2016-01-17 19:38:17

• QA Check changed from Info Needed to Ready for QA

Updated my branch. I now just used the corresponding icons and described the position (e.g. “in the top bar of the window”). Maybe this would be sufficient?

#7 Updated by sajolida 2016-01-18 17:53:55

• Status changed from New to Confirmed
• Assignee changed from sajolida to spriver
• Target version set to Tails_2.0
• Feature Branch changed from spriver:doc/10934-reset-linux to doc/10934-reset-linux

#8 Updated by spriver 2016-01-19 13:36:34

• Assignee changed from spriver to sajolida

Everything is okay. I checked your changes (thanks for explaining them all, I think this should help in future work). I hope that this all isn’t too much work for you as this is my first work on the original doc ;)
Is there anything else I have to do regarding this ticket?

#9 Updated by sajolida 2016-01-29 19:59:27

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

Nothing else needs to be done on this one (maybe setting “QA Check” as “Pass”, next time). So I’m merging, congrats!

#10 Updated by sajolida 2016-02-03 19:42:50

• Assignee deleted (sajolida)