Feature #9351

Document paperkey

Added by sajolida 2015-05-06 10:46:48 . Updated 2015-05-11 14:27:25 .

Status:
Resolved
Priority:
Elevated
Assignee:
sajolida
Category:
Target version:
Start date:
2015-05-06
Due date:
% Done:

100%

Feature Branch:
doc/9351-paperkey
Type of work:
End-user documentation
Blueprint:

Starter:
Affected tool:
Deliverable for:

Description


Subtasks


Related issues

Related to Tails - Feature #5316: Improve OpenPGP documentation Confirmed 2014-01-05

History

#1 Updated by sajolida 2015-05-06 10:47:24

  • Assignee set to sajolida

#2 Updated by sajolida 2015-05-06 11:08:13

  • Subject changed from Document papercut to Document paperkey

#3 Updated by sajolida 2015-05-06 11:12:06

#4 Updated by sajolida 2015-05-06 11:12:10

This was meant to be part of Feature #5316, but Feature #5316 will likely not be ready in time for 1.4, so let’s work on this here.

#5 Updated by sajolida 2015-05-06 14:25:09

  • Assignee changed from sajolida to BitingBird
  • QA Check set to Ready for QA

BitingBird: can you review this in time for 1.4 as this is a new application?

#6 Updated by sajolida 2015-05-06 14:32:41

  • Feature Branch set to doc/9351-paperkey

#7 Updated by sajolida 2015-05-06 14:34:05

  • Status changed from Confirmed to In Progress

Applied in changeset commit:0f71c7a5e1e0e5673cdfb65c693c9c2fb42fc08d.

#8 Updated by BitingBird 2015-05-06 18:03:11

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

I’d replace occurrences of “back up” with “backup” everywhere, as you currently use both. Also replace “command line” with “command-line” (wp uses https://en.wikipedia.org/wiki/Command-line_interface).

I don’t like the sentence in wiki/src/doc/about/features.mdwn : I’d replace “* [Paperkey](”$“:http://www.jabberwocky.com/software/paperkey/) to back up OpenPGP secret keys on paper (command line)” with “* [Paperkey](”$“:http://www.jabberwocky.com/software/paperkey/), a command-line tool to backup OpenPGP secret keys on paper”

Maybe “OpenPGP” could be a link to the seahorse page, once it’s merged?

You use both paperkey and paperkey - does it look the same once the wiki syntax applies?

Otherwise, looks good :)

#9 Updated by sajolida 2015-05-11 11:51:10

  • QA Check changed from Dev Needed to Ready for QA
  • “Backup” is the noun, and “back up” is the verb. See all the style guides I pointed you to.
  • We’ve been using “command line” (without hyphen) as in GDSG quite consistenly in the rest of the doc so I’ll stick to that.
  • I rewrote the entry in /doc/about/features to remove the parenthesis and so did the same for keyringer.
  • *paperkey* and <span class="application"> produce the same result. I’ve been lazy at using the markup lately, but yes, we should do that at least in /doc.
  • I couldn’t merge the Seahorse documentation in time.

So we’re done!

#10 Updated by sajolida 2015-05-11 11:53:29

  • Status changed from In Progress to Resolved
  • % Done changed from 0 to 100

Applied in changeset commit:cffdc26460ead8f0ef90802e1ecc3eae7ddd73a1.

#11 Updated by BitingBird 2015-05-11 14:27:26

  • QA Check changed from Ready for QA to Pass