Project

General

Profile

Bug #14788

Feature #14548: Fix issues identified in the expert review done by jaster on our installation instructions

Add anchors to the troubleshooting parts of the installation doc

Added by goupille almost 2 years ago. Updated 9 days ago.

Status:
Needs Validation
Priority:
Normal
Assignee:
Category:
Installation
Target version:
Start date:
10/04/2017
Due date:
% Done:

0%

Feature Branch:
Type of work:
Website
Blueprint:
Starter:
Affected tool:

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.


Related issues

Related to Tails - Feature #15130: Restructure our support page and content Confirmed 09/28/2013
Related to Tails - Bug #12474: Document troubleshooting tips for more failure scenarios throughout installation assistant Rejected 12/05/2017
Related to Tails - Bug #10649: Have a video to explain how to start Tails (and use the boot menu key) Needs Validation 11/24/2015
Duplicated by Tails - Bug #15015: Install doc sections should be easily linkable Duplicate 12/05/2017
Duplicated by Tails - Feature #15129: Improve visibility of troubleshooting sections Duplicate 12/27/2017
Blocks Tails - Feature #16711: Core work 2019Q3 → 2019Q4: Technical writing Confirmed

History

#1 Updated by intrigeri almost 2 years ago

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 over 1 year ago

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

#3 Updated by sajolida over 1 year ago

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

#4 Updated by emmapeel over 1 year ago

  • Duplicated by Bug #15015: Install doc sections should be easily linkable added

#5 Updated by sajolida over 1 year ago

  • Parent task set to #14548

#6 Updated by sajolida over 1 year ago

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

#7 Updated by sajolida over 1 year ago

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

#8 Updated by sajolida over 1 year ago

  • Duplicated by Feature #15129: Improve visibility of troubleshooting sections added

#9 Updated by sajolida over 1 year ago

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

#10 Updated by sajolida over 1 year ago

  • Description updated (diff)

#11 Updated by sajolida over 1 year ago

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

#12 Updated by sajolida over 1 year ago

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

#13 Updated by sajolida over 1 year ago

I'm out of budget for this quarter.

#14 Updated by sajolida 10 months ago

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

#15 Updated by sajolida 10 months ago

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

#16 Updated by sajolida 10 months ago

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

#17 Updated by sajolida 10 months ago

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

#18 Updated by intrigeri 10 months ago

  • Target version set to 2019

#20 Updated by sajolida 3 months ago

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

#21 Updated by sajolida 2 months ago

  • Target version deleted (Tails_3.15)

#22 Updated by sajolida about 1 month ago

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

#23 Updated by sajolida about 1 month ago

  • 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 (#10649).

#24 Updated by sajolida about 1 month ago

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

#25 Updated by sajolida about 1 month ago

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

@emmapeel @goupille

In b46827df4f (part of #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 #10649 is merged.

Sorry for the delay on this ticket but it was really not a simple fix and #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 #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 #10649.

#26 Updated by sajolida about 1 month ago

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

#27 Updated by goupille about 1 month ago

  • Assignee changed from goupille to sajolida

sajolida wrote:

@emmapeel @goupille

In b46827df4f (part of #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 #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 #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 #10649 and it seems very good to me

#28 Updated by sajolida 9 days ago

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

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

#29 Updated by sajolida about 4 hours ago

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

#30 Updated by sajolida about 4 hours ago

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

Also available in: Atom PDF