Feature #7694

Document email client

Added by sajolida 2014-07-31 09:26:08 . Updated 2015-04-06 21:12:10 .

Status:
Resolved
Priority:
Elevated
Assignee:
sajolida
Category:
Target version:
Start date:
2014-07-31
Due date:
% Done:

0%

Feature Branch:
doc/7694-email_client
Type of work:
End-user documentation
Blueprint:

Starter:
Affected tool:
Email Client
Deliverable for:

Description


Subtasks


Related issues

Related to Tails - Feature #8301: Document how to configure a Riseup account in Claws Resolved 2014-11-24
Related to Tails - Feature #8419: Point back from persistence features to the relevant tools Resolved 2014-12-11
Related to Tails - Feature #9159: Test that the persistence bug of Claws is documented correctly Resolved 2015-04-06
Blocks Tails - Feature #7685: Document alternative email providers Rejected 2014-10-27

History

#1 Updated by sajolida 2014-07-31 09:26:25

  • blocks Feature #7685: Document alternative email providers added

#2 Updated by intrigeri 2014-08-12 13:39:46

  • Category set to 212

#3 Updated by BitingBird 2014-12-03 16:06:10

  • Status changed from Confirmed to In Progress
  • QA Check set to Ready for QA

#4 Updated by BitingBird 2014-12-03 18:15:22

  • Assignee set to sajolida
  • Target version set to Tails_1.2.2
  • Feature Branch set to bitingbird:doc/7694-email_client

#5 Updated by BitingBird 2014-12-03 20:38:15

  • related to Feature #8301: Document how to configure a Riseup account in Claws added

#6 Updated by sajolida 2014-12-11 16:24:00

  • related to Feature #8419: Point back from persistence features to the relevant tools added

#7 Updated by sajolida 2014-12-11 16:27:09

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

Thanks the patch.

First, I had the same Git problems as with Bug #7118. So please do reset your branch in the same way.

  • You need to call your page with a .mdwn extension. My ikiwiki doesn’t even build the page without it. It’s important to build the wiki for each one of your changes to limit the number of formatting mistakes that you might ask others to review.
  • We usually only use lower name in URLs. Some pages might have capital letter like Tor_Browser but those are very old and all the new pages created recently have consistent lower case names.
  • You didn’t add this page to the doc index. See wiki/src/doc/anonymous_internet.index.mdwn.
  • We don’t talk about “the persistence” only, please refer for other documentation pages where we already point to other persistence features.
  • When writing internal links, don’t point to the path of the compiled HTML pages (eg. index.en.html#index5h2). See the ikiwiki link pages and subpages: http://ikiwiki.info/ikiwiki/wikilink/. Building the wiki should make it clear.
  • What about moving the note that’s in “/doc/first_steps/persistence/configure#index5h2” on this page as well?
  • And what do you think about Feature #8419?

#8 Updated by sajolida 2014-12-11 16:51:09

  • Feature Branch changed from bitingbird:doc/7694-email_client to doc/7694-email_client

#9 Updated by anonym 2014-12-12 16:41:57

  • Target version changed from Tails_1.2.2 to Tails_1.2.3

#10 Updated by sajolida 2014-12-25 15:48:21

  • related to deleted (Feature #8419: Point back from persistence features to the relevant tools)

#11 Updated by sajolida 2014-12-25 15:48:30

  • related to Feature #8419: Point back from persistence features to the relevant tools added

#12 Updated by BitingBird 2015-01-08 05:35:15

  • Target version changed from Tails_1.2.3 to Tails_1.3

#13 Updated by BitingBird 2015-01-16 13:33:48

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

Implemented all your suggestions. I was not sure what part of the “note that’s in ”/doc/first_steps/persistence/configure#index5h2“” you suggested to move, all of it seemed pertinent so I copied it all. I also linked from the persistence doc, as suggested in Feature #8419.

Please review :)

#14 Updated by BitingBird 2015-01-26 11:06:31

I built the wiki and it looks good.

#16 Updated by BitingBird 2015-02-08 14:17:31

  • Priority changed from Normal to Elevated

This one is a big one, but it really would be great to have.

#17 Updated by sajolida 2015-02-19 15:33:06

  • Target version changed from Tails_1.3 to Tails_1.3.2

I won’t have time to review this in depth before 1.3, so I’m postponing, sorry.

#18 Updated by intrigeri 2015-02-23 11:19:27

  • Feature Branch changed from doc/7694-email_client to bitingbird:doc/7694-email_client

#19 Updated by BitingBird 2015-03-12 22:33:18

  • Feature Branch changed from bitingbird:doc/7694-email_client to doc/7694-email_client

#20 Updated by BitingBird 2015-03-19 14:26:59

  • Target version changed from Tails_1.3.2 to Tails_1.4

#21 Updated by sajolida 2015-04-05 15:25:10

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

Easy stuff:

  • Use named anchors instead of #index4h2.
  • What about adding the Claws Mail logo on that page, maybe below “click on the Claws Mail icon in the application shortcuts”?

More complicated stuff:

  • You local branch might still be based on the old version of the Git repo, so make sure to reset your branch to what’s in origin.
  • I still don’t like the part about email providers as I already expressed in Feature #7436 and this should be treated as Feature #7685.
  • So I propose to remove everything related to email providers, and rename what’s left to mention more explicitely OpenPGP encryption (which is not mentioned yet), what it does and what are its limitations.

#22 Updated by sajolida 2015-04-05 15:27:42

And, and while you’re at it, it would be super nice to verify that the content of /doc/anonymous_internet/claws_mail/persistence.bug.mdwn is accurate because people complained about it recently. You’ll find credentials for our riseup test accounts in the internal keyringer repo.

#23 Updated by BitingBird 2015-04-05 16:51:49

  • Feature Branch changed from doc/7694-email_client to bitingbird:doc/7694-email_client

#24 Updated by BitingBird 2015-04-05 17:35:31

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

Corrected the link, added the icon, moved providers things in dedicated branch (and page).

I’ll document encrypted emails in Feature #5316, so I won’t start messing with it here otherwise I’ll have conflicts later :)

I didn’t do the testing part, I have never tested Claws and it looks very complicated. I can open a ticket about that so that it’s done later, and we can merge this now?

Built, looks good - please review :)

#25 Updated by sajolida 2015-04-06 11:34:47

  • related to Feature #9159: Test that the persistence bug of Claws is documented correctly added

#26 Updated by sajolida 2015-04-06 11:38:16

  • Status changed from In Progress to Confirmed
  • QA Check changed from Ready for QA to Pass
  • Feature Branch changed from bitingbird:doc/7694-email_client to doc/7694-email_client

Thanks for the patches. I added two more on top and merged everything.

Regarding doc techniques, keep in mind that we should try to break translations as little as we can, for example by adding empty lines between anchors and previous content, see 2d18c36.

I created Feature #9519 to test the Claws Mails persistence bug. Note that as doc writers our first duty is to know how the tools behave and test them as we can’t document them otherwise. I marked Feature #9519 as an easy task as this is what we’re asking our users to do to be able to use email :)

#27 Updated by sajolida 2015-04-06 11:39:01

  • Status changed from Confirmed to Resolved

#28 Updated by intrigeri 2015-04-06 14:56:10

Yay! Pushed one minor fix on top (commit:093a9f5).

#29 Updated by BitingBird 2015-04-06 21:12:10

Youhou !