Project

General

Profile

Bug #10935

Feature #7584: Update documentation for Jessie

Bug #8043: Update Disks documentation for Jessie

Update password changing of persistence for Jessie

Added by spriver almost 4 years ago. Updated over 3 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
-
Category:
-
Target version:
Start date:
01/13/2016
Due date:
% Done:

0%

Feature Branch:
doc/10935-persistence-passphrase
Type of work:
End-user documentation
Blueprint:
Starter:
Affected tool:

Description

Tails 2.0 comes with GNOME Disks as disk-management tool. The GUI changed a lot.

Associated revisions

Revision 08c59e19
Added by sajolida over 3 years ago

Merge remote-tracking branch 'origin/doc/10935-persistence-passphrase' (Closes: #10935)

History

#1 Updated by sajolida almost 4 years ago

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

This is marked as "Ready for QA" but there's no "Feature Branch" set. Where is the work I should review?

#2 Updated by spriver almost 4 years ago

  • Assignee changed from spriver to sajolida
  • QA Check changed from Info Needed to Ready for QA
  • Feature Branch set to spriver:doc/10935-persistence-passphrase

#3 Updated by sajolida almost 4 years ago

  • Status changed from New to Confirmed
  • Assignee changed from sajolida to spriver
  • QA Check changed from Ready for QA to Dev Needed

Cool! This one is almost ready. A few nitpicking comments and recommendations for future work:

  • Update config/base_branch to "testing".
  • What about removing the big titles of the section? We have 10 steps
    in total. That's quite a bit but should be ok.
  • What about removing the step "verify that the device corresponds to
    your device"? This would only be helpful for people with multiple
    Tails devices plugged in the same machine so maybe it's not worth
    bothering everybody with this. I know I wrote this myself a while ago :)
  • We need to clarify the doc style for menus without labels like for
    #10934 but for the time being, let's stick to what we're been doing
    in /install/linux/usb.
  • We often have to point to the "administration password"
    instructions, so I think we can reuse a shorter formulation
    everytime. What about "1. Start Tails and set up an administration
    password." (like in check_file_system.mdwn) or "Set up an
    administration password when starting Tails"?
  • Markdown calculates automatically the number of the steps, so
    there's no need to number them manually in the doc. Actually I prefer
    always writing "1. ". So your change to line 34 was not needed but
    that's ok.
  • We say "choose" for choosing option from a menu. "Select" is for
    selections things in a drop-dop, a selector, etc. See
    https://developer.gnome.org/gdp-style-guide/2.32/gdp-style-guide.html#gnome-glossary-user-actions. So
    you're step 2 needs to be adjusted.
  • Use to encode a true ellipsis instead of three dots in
    step 2.
  • Your step 5 could probably be shorten with something like "In the
    confirmation dialog, enter your administration password and click
    Authenticate"." About the phrasing of clicks see GDSG "click".
  • We underline titles with '=' upto the lenght of the title :)

#4 Updated by sajolida almost 4 years ago

Errata: you don't have to use to do an ellipsis. You can also type one directly or copy paste it from somewhere else :)

See https://en.wikipedia.org/wiki/Ellipsis.

#5 Updated by sajolida almost 4 years ago

Regarding the administration password, what do you think of b302a6c?

#6 Updated by spriver almost 4 years ago

  • Assignee changed from spriver to sajolida
  • QA Check changed from Dev Needed to Ready for QA

sajolida wrote:

Cool! This one is almost ready. A few nitpicking comments and recommendations for future work:

  • Update config/base_branch to "testing".

I tried to rebase on testing, but config/base_branch stayed devel. I hope for this time this is okay?

  • What about removing the big titles of the section? We have 10 steps
    in total. That's quite a bit but should be ok.

Did it. Good idea, the page is a lot more clear now.

  • What about removing the step "verify that the device corresponds to
    your device"? This would only be helpful for people with multiple
    Tails devices plugged in the same machine so maybe it's not worth
    bothering everybody with this. I know I wrote this myself a while ago :)

Understood and did it ;)

  • We need to clarify the doc style for menus without labels like for
    #10934 but for the time being, let's stick to what we're been doing
    in /install/linux/usb.

I included the icon now. I think this should be clear enough? (I'm not a fan of huge screenshots and try to avoid them as good as possible)

  • We often have to point to the "administration password"
    instructions, so I think we can reuse a shorter formulation
    everytime. What about "1. Start Tails and set up an administration
    password." (like in check_file_system.mdwn) or "Set up an
    administration password when starting Tails"?

Shortened it.

  • Markdown calculates automatically the number of the steps, so
    there's no need to number them manually in the doc. Actually I prefer
    always writing "1. ". So your change to line 34 was not needed but
    that's ok.

Changed it back together with removing the titles.

Changed it.

  • Your step 5 could probably be shorten with something like "In the
    confirmation dialog, enter your administration password and click
    Authenticate"." About the phrasing of clicks see GDSG "click".

Changed it ;)

  • We underline titles with '=' upto the lenght of the title :)

I pushed the updated branch, I hope the changes are okay (:

#7 Updated by sajolida over 3 years ago

  • Status changed from Confirmed to Resolved
  • Assignee deleted (sajolida)
  • QA Check deleted (Ready for QA)
  • Feature Branch changed from spriver:doc/10935-persistence-passphrase to doc/10935-persistence-passphrase

Perfect! I'm merging then!

Also available in: Atom PDF