Feature #11949

Prepare new Greeter documentation for inline help

Added by sajolida 2016-11-17 16:47:45 . Updated 2020-04-15 06:01:03 .

Status:
Resolved
Priority:
Elevated
Assignee:
Category:
Target version:
Tails_3.0~rc1
Start date:
2016-11-17
Due date:
% Done:

100%

Feature Branch:
doc/5680-new-greeter
Type of work:
End-user documentation
Blueprint:

Starter:
Affected tool:
Welcome Screen
Deliverable for:

Description

In several places in the new Greeter we have help buttons pointing people to the documentation. This documentation should be prepare to received each of these help buttons.

Ideally, each info button would point to a dedicated page with only the relevant information. But if we also want to have this information in the general documentation, then we need to rely on inline which are sometimes problematic. In this particular case, inlines might not be worth it and we’ll instead point people to sections of the general documentation about Tails Greeter:

  • Point the info button on “Language & Region” to a new section of /doc/first_steps/startup_options right below the Greeter screenshot.
  • Remove the info button on “Encrypted Persistent Storage” because only people who already have a persistent storage would see that. It will be much more relevant once people will be able to create the persistent storage from the Greeter (Feature #12379).
  • Point the info button on “Additional settings” to a new section of /doc/first_steps/startup_options improving on the current index of dedicated pages per settion.
  • Add a “More info” link below the paragraph describing each additional setting and pointing to :
    • /doc/first_steps/startup_options/administration_password
    • /doc/first_steps/startup_options/mac_spoofing
    • /doc/first_steps/startup_options/network_configuration
  • Hide the side bar on embeded documentation.

Subtasks

Related issues

Blocks Tails - Feature #12432: Technical writing core work 2017Q2 Resolved 2017-04-07

History

#1 Updated by alant 2016-12-23 16:37:41

There should be 3 entry points for inline help:

  • Language & Region
  • Encrypted Persistent Storage
  • Additional Settings

#2 Updated by intrigeri 2016-12-23 17:32:39

  • Target version set to Tails_3.0

I’m going to merge the new Greeter into feature/stretch, so this will become a blocker for Tails 3.0.

#3 Updated by intrigeri 2017-03-17 12:55:06

  • Priority changed from Normal to Elevated

#4 Updated by sajolida 2017-03-19 10:05:34

  • Description updated

#5 Updated by sajolida 2017-03-19 10:37:38

  • Description updated

#6 Updated by sajolida 2017-03-19 18:43:30

  • Assignee changed from sajolida to alant
  • QA Check set to Dev Needed
  • Feature Branch set to doc/5680-new-greeter

I pushed the changes we need to the documentation in doc/5680-new-greeter.

I wrote two new entry points:

  • #locale
  • #additional

The three pages for the additional settings can stay the same.

I’m assigning it to Alan for integration. Is that ok like this?

spriver should also review that but she can do that from Feature #5680.

#7 Updated by alant 2017-03-19 21:56:22

Intagration should be done in feature/11949-update-doc in the greeter repository.

#8 Updated by alant 2017-03-20 19:20:51

  • Status changed from Confirmed to In Progress
  • Assignee changed from alant to anonym

alant wrote:
> Intagration should be done in feature/11949-update-doc in the greeter repository.

I tested it works. feature/11949-update-doc should only be merged in the greeter once doc/5680-new-greeter is merged in Tails.

#9 Updated by intrigeri 2017-04-18 15:52:25

  • Assignee changed from anonym to spriver
  • Target version changed from Tails_3.0 to Tails_3.0~rc1
  • QA Check changed from Dev Needed to Ready for QA

Let’s refocus this ticket to cover the end-user doc only, and the integration bit can be tracked on the parent ticket (or on new, sibling tickets if needed).

spriver, can you please review this?

#10 Updated by spriver 2017-05-01 12:16:30

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

I’m fine with all updates. However, some questions:

- should we use a [[!toc levels=2]] in doc/first_steps/startup_options.mdwn and then point to the relevant sections “Language & region” resp. “Additional settings” by clicking the corresponding question marks in the Greeter? (now it’s pointing to the page doc/first_steps/startup_options.mdwn itself)

- is the update of doc/persistence/use.mdwn part of this ticket or will it be done somewhere else?

#11 Updated by sajolida 2017-05-07 09:52:10

  • Assignee changed from sajolida to spriver
  • QA Check changed from Info Needed to Ready for QA
  • I added a [[!toc levels=2]] so that it’s displayed on the page. But I already had added <a id=" anchors on the pages.
  • I updated the rest of the documentation to the new Greeter (some persistence and installation pages).
  • I pointed the help desk to some tickets related to the Greeter, pointed from the Known Issues but that are closed.
  • I documented the keyboard shortcuts.

So please have a look again.

#12 Updated by sajolida 2017-05-07 09:54:51

#13 Updated by spriver 2017-05-13 20:06:53

  • Assignee changed from spriver to sajolida
  • QA Check changed from Ready for QA to Pass

Nothing to add from my side. Shortcuts are also fine for me and are working (: Good job, I like the small screenshots.
Feel free to merge! (:

#14 Updated by sajolida 2017-05-16 12:04:29

  • Status changed from In Progress to Resolved
  • Assignee deleted (sajolida)
  • QA Check deleted (Pass)

Merged, thanks!

#15 Updated by intrigeri 2017-05-27 07:05:39

  • % Done changed from 0 to 100

#16 Updated by intrigeri 2020-04-15 06:01:04

  • Affected tool changed from Greeter to Welcome Screen