Feature #7268

Link to our doc from /doc/about/features

Added by sajolida 2014-05-19 23:52:39 . Updated 2015-04-25 06:08:51 .

Status:
Resolved
Priority:
Low
Assignee:
sajolida
Category:
Target version:
Start date:
Due date:
% Done:

100%

Feature Branch:
bitingbird:doc/7268-features_links
Type of work:
End-user documentation
Blueprint:

Starter:
0
Affected tool:
Deliverable for:

Description

The list of included software points to upstream websites. When
available it should rather point to our internal documentation about
each piece of software.


Subtasks


History

#1 Updated by intrigeri 2014-05-25 13:26:44

I’m not so sure.

Assuming the purpose of the about/features page is to give a broad
overview of what Tails is capable of, one could argue that a given
upstream software’s website is the best place to give up-to-date
details about its set of features. This addresses the
what? question.

We have different entry points for addressing the how? question,
that is to satisfy the needs of those who want to learn how to use
this or that piece of software in Tails.

Just my 2 bits. Your call, obviously :)

#2 Updated by sajolida 2014-05-26 02:44:46

> Assuming the purpose of the about/features page is to give a broad
> overview of what Tails is capable of, one could argue that a given
> upstream software’s website is the best place to give up-to-date
> details about its set of features. This addresses the
> what? question.
>
> We have different entry points for addressing the how? question,
> that is to satisfy the needs of those who want to learn how to use
> this or that piece of software in Tails.

I just find it weird to have Features mention KeePassX for example, but
with no link to our doc. Then I see two ways of solving this issue:

1. Have Features point to our doc. Then our doc points to upstream.
That’s already the case. See for example
https://tails.boum.org/doc/encryption_and_privacy/manage_passwords/
2. Have Features point to both upstream and our doc.

Shall we go for option 2 then, which would solve both our concerns?

#3 Updated by intrigeri 2014-05-26 04:43:49

  • Starter set to No

sajolida wrote:
> 2. Have Features point to both upstream and our doc.
>
> Shall we go for option 2 then, which would solve both our concerns?

Yes. This could e.g. be formatted as:

* [[Software name|upstream homepage URL]] $description  
  Read the corresponding documentation.

(Note the trailing spaces after $description, to force a newline.)

#4 Updated by sajolida 2014-09-21 08:49:18

  • Assignee deleted (sajolida)
  • Priority changed from Normal to Low

I tried several things but none of them convinced me. The thing is that more than half of the entries in the Features page refer to another part of our documentation (mostly user documentation but also design documentation).

So having “See the corresponding documentation” all the time is really heavy. I tried different things such as:

- putting only (more)
- putting arrow like the “next” arrow but smaller (but then faced a CSS blocker to make it look nice)

I lost faith in that ticket and will unassign it from me :)

#5 Updated by BitingBird 2015-01-19 03:29:58

  • Assignee set to BitingBird
  • Target version set to Tails_1.3

#6 Updated by BitingBird 2015-01-26 15:02:54

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

#7 Updated by BitingBird 2015-03-14 22:23:33

I think we could end each line with ([[doc|dedicated_page]]).

It would look like:

Do you think it would work?

#8 Updated by BitingBird 2015-03-14 22:23:50

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

#9 Updated by sajolida 2015-03-15 18:58:29

  • Assignee changed from sajolida to BitingBird
  • QA Check changed from Info Needed to Dev Needed

It’s probably not going to surprise you but I’d rather avoid abbreviations in our documentation. So I don’t like “doc”. What about “(More…)” instead? You could also ask for advice to Diddly-Squat on that kind of stuff. But I don’t think he has a Redmine account yet…

#10 Updated by BitingBird 2015-03-15 19:17:04

“More…” sounds good to me.

#11 Updated by BitingBird 2015-03-17 15:34:19

  • Status changed from Confirmed to In Progress
  • Feature Branch set to bitingbird:doc/7268-features_links

#12 Updated by BitingBird 2015-03-17 16:11:44

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

Added (More..) on all options that are documented (added a commit in the Claws ticket to do it in the branch also). Built, looks good - please review :)

#13 Updated by BitingBird 2015-03-19 14:27:57

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

#14 Updated by sajolida 2015-04-24 14:59:08

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

Applied in changeset commit:cfa085d7f97783983941fc1c90c9b2e785e7f5e1.

#15 Updated by sajolida 2015-04-24 15:00:47

  • QA Check deleted (Ready for QA)

#16 Updated by BitingBird 2015-04-25 06:08:51

Thanks :)