Feature #14788

Add anchors to the troubleshooting parts of the installation doc

Added by goupille 2017-10-04 19:40:28 . Updated 2020-03-25 01:36:44 .

Status:
In Progress
Priority:
Normal
Assignee:
sajolida
Category:
Installation
Target version:
Start date:
2017-10-04
Due date:
% Done:

0%

Feature Branch:
Type of work:
Website
Blueprint:

Starter:
Affected tool:
Deliverable for:

Description

Some part of the installation documentation are difficult to point to a user seeking support. As an example the following link just point to the top of the page:

https://tails.boum.org/install/win/usb/index.en.html#install-inc-steps-restart-first-time.inline.not-entirely

and not to the troubleshooting part.

it would be great if all those “troubleshooting notes” were anchored.

Or create a page dedicated to issues starting Tails as proposed on https://tails.boum.org/blueprint/support_page/.

Acknowledging that most people will have to go through the troubleshooting instructions, a first version of this could be to:

  • Remove the toggle and always display the troubleshooting instructions
  • Add a shortcut for the lucky few for whom the Boot Loader Menu will appear directly
  • Add anchors to the relevant parts

In the end it shouldn’t be tons of work as I thought initially.

Subtasks

Related issues

Related to Tails - Feature #15130: Restructure our support page and content Confirmed 2013-09-28
Related to Tails - Bug #12474: Document troubleshooting tips for more failure scenarios throughout installation assistant Rejected 2017-12-05
Related to Tails - Bug #10649: Have a video to explain how to start Tails (and use the boot menu key) Resolved 2015-11-24
Has duplicate Tails - Bug #15015: Install doc sections should be easily linkable Duplicate 2017-12-05
Has duplicate Tails - Feature #15129: Improve visibility of troubleshooting sections Duplicate 2017-12-27
Blocked by Tails - Feature #16925: Always add "debug nosplash" in troubleshooting mode Confirmed
Blocked by Tails - Feature #16926: Forget about USB sticks that used to be configured as fixed disks Resolved
Blocks Tails - Feature #17247: Core work 2020Q1 → 2020Q2: Technical writing Confirmed

History

#1 Updated by intrigeri 2017-10-05 07:01:39

> it would be great if all those “troubleshooting notes” were anchored.

Yes! When doing user support on our testers list or XMPP, I very often need to point users to “the XXX section on $PAGE”.

#2 Updated by sajolida 2017-11-06 10:34:09

  • blocks Feature #14758: Core work 2017Q4 → 2018Q1: Technical writing added

#3 Updated by sajolida 2017-12-28 00:55:31

  • related to Feature #15130: Restructure our support page and content added

#4 Updated by emmapeel 2018-01-18 10:38:18

  • has duplicate Bug #15015: Install doc sections should be easily linkable added

#5 Updated by sajolida 2018-02-01 20:08:41

#6 Updated by sajolida 2018-02-01 20:09:58

  • related to Feature #15129: Improve visibility of troubleshooting sections added

#7 Updated by sajolida 2018-02-01 20:10:04

  • related to deleted (Feature #15129: Improve visibility of troubleshooting sections)

#8 Updated by sajolida 2018-02-01 20:10:12

  • has duplicate Feature #15129: Improve visibility of troubleshooting sections added

#9 Updated by sajolida 2018-02-01 20:13:37

  • related to Bug #12474: Document troubleshooting tips for more failure scenarios throughout installation assistant added

#10 Updated by sajolida 2018-02-01 20:16:20

  • Description updated

#11 Updated by sajolida 2018-03-27 11:26:05

  • blocked by deleted (Feature #14758: Core work 2017Q4 → 2018Q1: Technical writing)

#12 Updated by sajolida 2018-03-27 11:26:11

  • blocks Feature #15411: Core work 2018Q2 → 2018Q3: Technical writing added

#13 Updated by sajolida 2018-03-27 11:26:18

I’m out of budget for this quarter.

#14 Updated by sajolida 2018-09-11 17:55:55

  • blocked by deleted (Feature #15411: Core work 2018Q2 → 2018Q3: Technical writing)

#15 Updated by sajolida 2018-09-11 17:55:58

  • related to Feature #15941: Core work 2018Q4 → 2019Q2: Technical writing added

#16 Updated by sajolida 2018-09-11 17:56:03

  • related to deleted (Feature #15941: Core work 2018Q4 → 2019Q2: Technical writing)

#17 Updated by sajolida 2018-09-11 17:56:09

  • blocks Feature #15941: Core work 2018Q4 → 2019Q2: Technical writing added

#18 Updated by intrigeri 2018-09-14 08:23:09

  • Target version set to 2019

#19 Updated by sajolida 2019-03-14 17:03:14

  • related to #15885 added

#20 Updated by sajolida 2019-04-17 13:50:50

  • Description updated
  • Target version changed from 2019 to Tails_3.15

#21 Updated by sajolida 2019-05-10 11:14:54

  • Target version deleted (Tails_3.15)

#22 Updated by sajolida 2019-06-12 09:42:48

  • related to Bug #10649: Have a video to explain how to start Tails (and use the boot menu key) added

#23 Updated by sajolida 2019-06-12 09:43:37

  • Category set to Installation
  • Target version set to Tails_3.15

I’ll add a link to “Tails does not start at all” while integrating the boot menu key animation (Bug #10649).

#24 Updated by sajolida 2019-06-13 18:13:33

  • related to deleted (Bug #10649: Have a video to explain how to start Tails (and use the boot menu key))

#25 Updated by sajolida 2019-06-13 19:34:47

  • Status changed from Confirmed to Needs Validation
  • Assignee changed from sajolida to goupille

emmapeel goupille

In b46827df4f (part of Bug #10649), I’m adding anchors to:

  • “Getting to the boot menu” (#boot-menu).
  • “Edit the BIOS settings” (#bios-settings).
  • “Reporting the problem to our support team” (#report).

Note that these won’t be live before Bug #10649 is merged.

Sorry for the delay on this ticket but it was really not a simple fix and Bug #10649 was a good opportunity to dive again in this mess.

I haven’t yet added anchors to “Tails does not start entirely”. It would be simplier to fix (because it’s the same on PC and Mac) but I’m afraid that the content of this section needs quite more work (for now I haven’t changed much to the content itself).

Could you help me understand how much of your need is already covered by the 3 anchors I’m adding in Bug #10649? Will they cover half of the requests? more than half? only a few of them?

I’m marking this ticket as needing validation and assigning to @goupille who’s on shift now. Please have a look at the compiled HTML that I’m attaching to Bug #10649.

#26 Updated by sajolida 2019-06-14 11:22:10

  • related to Bug #10649: Have a video to explain how to start Tails (and use the boot menu key) added

#27 Updated by goupille 2019-06-15 20:06:00

  • Assignee changed from goupille to sajolida

sajolida wrote:
> emmapeel goupille
>
> In b46827df4f (part of Bug #10649), I’m adding anchors to:
>
> * “Getting to the boot menu” (#boot-menu).
> * “Edit the BIOS settings” (#bios-settings).
> * “Reporting the problem to our support team” (#report).
>
that’s great !

> Note that these won’t be live before Bug #10649 is merged.

I think we can wait a little longer :)

> Could you help me understand how much of your need is already covered by the 3 anchors I’m adding in Bug #10649? Will they cover half of the requests? more than half? only a few of them?

I think that answers most if not all my initial concerns, I also took a look at the files you attached to Bug #10649 and it seems very good to me

#28 Updated by sajolida 2019-07-09 09:45:32

  • Target version changed from Tails_3.15 to Tails_3.16

Yay! If Help desk is happy, I’m happy.

#29 Updated by sajolida 2019-07-18 16:53:12

  • blocks Feature #16711: Core work 2019Q3 → 2019Q4: Technical writing added

#30 Updated by sajolida 2019-07-18 16:53:16

  • blocked by deleted (Feature #15941: Core work 2018Q4 → 2019Q2: Technical writing)

#32 Updated by sajolida 2019-07-30 18:11:50

  • related to Feature #16925: Always add "debug nosplash" in troubleshooting mode added

#33 Updated by sajolida 2019-07-30 19:11:59

We’re talking about 2 different sections here: “Tails not starting at all” and “Tails not starting entirely”.

A big difference between the 2 is that “Tails not starting at all” will be needed by pretty much everybody while “Tails not starting entirely” will only be used by a minority of people.

I’m happy that we are now showing “Tails not starting at all” to everybody (and it will get much smaller once we support Secure Boot).

But I’m a bit reluctant to display all the crap in “Tails not starting entirely” to everybody else, at least unless we manage to clean it drastically (Feature #16925 and Feature #16926 could help).

We also already have an anchor not to far from “Tails not starting entirely”: https://tails.boum.org/install/win/usb/#greeter.

So I’ll wait and see how Feature #16925 and Feature #16926 go before deciding something here.

#34 Updated by sajolida 2019-07-30 19:12:10

  • Tracker changed from Bug to Feature

#35 Updated by sajolida 2019-07-30 19:12:22

  • related to deleted (Feature #16925: Always add "debug nosplash" in troubleshooting mode)

#36 Updated by sajolida 2019-07-30 19:12:34

  • blocked by Feature #16925: Always add "debug nosplash" in troubleshooting mode added

#37 Updated by sajolida 2019-07-30 19:12:47

  • blocked by Feature #16926: Forget about USB sticks that used to be configured as fixed disks added

#38 Updated by sajolida 2019-07-30 20:08:02

  • Status changed from Needs Validation to In Progress

#39 Updated by sajolida 2019-08-01 18:30:05

Pro tip: The “Troubleshooting Mode” can break things (eg. GDM in my X201). It disables a lot of features that are needed in some cases.

#40 Updated by sajolida 2019-09-03 09:35:32

  • Target version changed from Tails_3.16 to Tails_3.17

#41 Updated by intrigeri 2019-09-12 14:25:18

  • Target version changed from Tails_3.17 to Tails_4.0

#42 Updated by intrigeri 2019-10-21 11:46:13

  • Target version changed from Tails_4.0 to Tails_4.1

#43 Updated by sajolida 2019-11-21 19:05:13

  • blocked by deleted (Feature #16711: Core work 2019Q3 → 2019Q4: Technical writing)

#44 Updated by sajolida 2019-11-21 19:05:26

  • blocks Feature #17247: Core work 2020Q1 → 2020Q2: Technical writing added

#45 Updated by sajolida 2019-11-21 19:05:36

Let’s go back to this once we have Secure Boot.

#46 Updated by sajolida 2019-11-21 19:05:50

  • Target version deleted (Tails_4.1)

#47 Updated by sajolida 2020-03-25 01:36:44

@goupille: Actually, the anchor “#greeter” already sends people to the section that includes “Tails not starting entirely”:

https://tails.boum.org/install/win/usb/#greeter

So I won’t wort more on this ticket until Feature #16925 is solved, which is itself blocked by Bug #16677.