Project

General

Profile

Feature #9323

Adapt current documentation with the Installation Assistant

Added by sajolida over 4 years ago. Updated over 3 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
-
Category:
Installation
Target version:
Start date:
11/27/2015
Due date:
% Done:

100%

Feature Branch:
web/9323-replace-old-documentation
Type of work:
End-user documentation
Blueprint:
Starter:
Affected tool:
Installation Assistant

Description

Probably:

  • Get rid of the duplicate information (a lot)
  • Add direct links to the different overviews
  • Adapt inc/stable_i386_iso_size.html
  • Write RewriteRules from the old pages to the new
  • Update list of core pages
  • Design how to integrate the scenarios in the doc [94]
  • Redirect /download to /install
  • Change "Download" button into "Install" button
  • Remove "noindex"
  • Rescue shared images (eg. from doc/first_steps/startup_options)

Capture du 2016-01-15 17_39_29.png View (13.2 KB) tchou, 01/15/2016 04:47 PM


Subtasks

Feature #10675: Write "Learn how to do that" for OpenPGP verificationResolved

Feature #11027: Decide what to do with the old OpenPGP verification instructionsResolved

Bug #11220: Provide a direct link to OpenPGP signature of ISO imageResolved


Related issues

Related to Tails - Feature #11151: Speed up the build of the website Resolved 12/23/2015
Duplicated by Tails - Bug #11222: https://tails.boum.org/download/ Should redirect to https://tails.boum.org/install/ Duplicate 03/11/2016

Associated revisions

Revision 0fa570f3
Added by anonym almost 4 years ago

Merge remote-tracking branch 'origin/web/9323-replace-old-documentation' into devel

Fix-committed: #9323

Revision 44a381c5
Added by sajolida over 3 years ago

Merge branch 'web/9323-replace-old-documentation' (Closes: #9323)

Conflicts:
wiki/src/support/known_issues.de.po
wiki/src/support/known_issues.fa.po
wiki/src/support/known_issues.fr.po
wiki/src/support/known_issues.pt.po

History

#1 Updated by sajolida over 4 years ago

  • Affected tool set to Installation Assistant

#2 Updated by sajolida over 4 years ago

  • Subject changed from Assistant: Adapt current document to the future assistant to Assistant: Adapt current documentation to the future assistant

#3 Updated by BitingBird over 4 years ago

  • Category set to Installation

#4 Updated by sajolida over 4 years ago

  • Target version set to Tails_1.8

#5 Updated by sajolida about 4 years ago

  • Description updated (diff)

#6 Updated by sajolida about 4 years ago

  • Description updated (diff)

#7 Updated by sajolida about 4 years ago

  • Description updated (diff)

#8 Updated by sajolida about 4 years ago

  • Target version changed from Tails_1.8 to 246

#9 Updated by sajolida about 4 years ago

  • Parent task deleted (#8590)

#10 Updated by sajolida about 4 years ago

  • Parent task set to #8592

#11 Updated by sajolida about 4 years ago

  • Description updated (diff)

#12 Updated by sajolida about 4 years ago

  • Description updated (diff)

#13 Updated by sajolida about 4 years ago

  • Description updated (diff)

#14 Updated by sajolida about 4 years ago

  • Target version changed from 246 to Tails_2.0

#15 Updated by sajolida about 4 years ago

  • Description updated (diff)

#16 Updated by sajolida about 4 years ago

  • Description updated (diff)

#17 Updated by sajolida almost 4 years ago

  • Priority changed from Normal to Elevated

#18 Updated by sajolida almost 4 years ago

  • Assignee changed from sajolida to tchou
  • QA Check set to Ready for QA

This one is a complicated one. In the middle of working on this I
decided to temporarily remove the OpenPGP instructions see e66558a
and 8deae6a, tell me what you think.

This integration also lacks fixing doc/first_steps/start_tails as
this would require modifying the ikiwiki configuration on boum.org
to disable htmlscrubber on this page (so we can reuse the content
of inc/steps/restart_first_time.inline. If you think that's really
important, I don't mind doing it but honestly, I think we have
more urgent things to do and I created #10883 to track this.

#19 Updated by tchou almost 4 years ago

  • Feature Branch set to 9323-release-ia

#20 Updated by tchou almost 4 years ago

Just 2 things:

- related to #10938: I would suggest (if we keep a download only page) not to have it as the first item of the "Download & install" section.

- there is some double previous/next navigation items in almost every pages (maybe it's my setup). screenshot in attachement.

Glad to see "Install Tails 1.8.2" in the homepage :)

#21 Updated by sajolida almost 4 years ago

- related to #10938: I would suggest if we keep en download only page not to have it as the first item of the "Download & install" section.

Good idea! I moved it last in 3dffc6a.

- there is some double previous/next navigation items in almost every pages (maybe it's my setup). screenshot in attachement.

I've seen this as well but never on the production website, so I think
that's a glitch on some ikiwiki setup or state. For example, I rebuilt
this branch here and don't see it on "Startup Options" (your screenshot).

Glad to see "Install Tails 1.8.2" in the homepage :)

Yeah!

So this branch is good. I'll keep it on the side until we're ready for
the final release!

#22 Updated by sajolida almost 4 years ago

  • Status changed from Confirmed to 11
  • QA Check changed from Dev Needed to Pass

#23 Updated by sajolida almost 4 years ago

  • Related to Feature #10675: Write "Learn how to do that" for OpenPGP verification added

#24 Updated by sajolida almost 4 years ago

  • Feature Branch changed from 9323-release-ia to web/9323-replace-old-documentation

To be more careful while releasing, the old instructions won't be removed on the first official release of the assistant (#8592), so I'm renaming this branch.

#25 Updated by sajolida almost 4 years ago

  • Target version changed from Tails_2.0 to Tails_2.2
  • Parent task deleted (#8592)
  • QA Check changed from Pass to Dev Needed

This will need more work as we're likely to merge another branch (web/8592-release-ia #8592).

#26 Updated by sajolida almost 4 years ago

  • Subject changed from Assistant: Adapt current documentation to the future assistant to Adapt current documentation with the Installation Assistant

#27 Updated by sajolida almost 4 years ago

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

All-right. So I redid some of the work I did on 9323-release-ia into a new branch: web/9323-replace-old-documentation. I went up to removing the old download page while keeping the OpenPGP instructions (until #11027 is sorted).

This is not enough to close this ticket but I think it's a good step forward. So I'm asking for a review and merge of this. Then I'll move on to adapting again the "First steps with Tails" section which is still duplicated in this branch.

#28 Updated by sajolida almost 4 years ago

#29 Updated by anonym almost 4 years ago

  • Status changed from 11 to In Progress
  • Assignee changed from anonym to sajolida
  • QA Check changed from Ready for QA to Dev Needed

Looks good!

I by mistake added Fix-committed to my merge commit. Undoing that and reassigning to you.

#30 Updated by anonym almost 4 years ago

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

#31 Updated by anonym almost 4 years ago

  • Assignee deleted (sajolida)
  • QA Check changed from Dev Needed to Pass

#32 Updated by intrigeri almost 4 years ago

  • Status changed from 11 to In Progress
  • Assignee set to sajolida
  • Target version changed from Tails_2.2 to Tails_2.3
  • QA Check deleted (Pass)

sajolida wrote:

This is not enough to close this ticket but I think it's a good step forward.

Adjusting metadata accordingly (hopefully I got it right).

#33 Updated by sajolida over 3 years ago

  • Duplicated by Bug #11222: https://tails.boum.org/download/ Should redirect to https://tails.boum.org/install/ added

#34 Updated by sajolida over 3 years ago

  • Assignee changed from sajolida to intrigeri
  • QA Check set to Ready for QA

3a668b5 should fix the concern raised on #11222. This should really be super quick to review and merge.

Then assign this ticket back to me until I rewrite the rest of the adaptation.

I originally did that with much care in my first branch but forgot about redirections on the rewrite for 2.0 :(

#35 Updated by intrigeri over 3 years ago

  • Assignee changed from intrigeri to sajolida
  • QA Check deleted (Ready for QA)

Done!

#37 Updated by sajolida over 3 years ago

  • Target version deleted (Tails_2.3)

#38 Updated by sajolida over 3 years ago

  • Description updated (diff)

"* What do we ship in the ISO image?" will be dealt with in #11101.

#39 Updated by sajolida over 3 years ago

  • Assignee changed from sajolida to anonym
  • QA Check set to Ready for QA
  • Feature Branch changed from web/9323-replace-old-documentation to web/9323-replace-old-documentatweb/9323-replace-old-documentationion

All-right, so this is ready for review again. Most of this stuff is affecting other parts of the website than the assistant, the release process, etc., so I'm assigning to anonym. But maybe you can find someone else :)

This was a lot of work and very chaotic, so I appologize in advance for the very messy Git history!

Also, I expect this work to conflict with the translations that people are doing on the assistant in parallel of this work (pending French and German reviews) so the faster we merge this one, the more conflicts we'll prevent. Still, I don't mind solving a few conflict as I'm the one to generate them :)

Also, despite the description of this ticket, I decided not to update the link in Tails Installer to prevent breaking translation. We'll have a redirection after all.

#40 Updated by sajolida over 3 years ago

Oh, and regarding language statistics, this branch removes 15% of words on the core pages but brings down the translated percentage quite a bit:

  - German:     91% to 77%
  - Farsi:      72% to 42%
  - French:     89% to 73%
  - Portuguese: 69% to 43%

#41 Updated by sajolida over 3 years ago

  • Related to deleted (Feature #10675: Write "Learn how to do that" for OpenPGP verification)

#42 Updated by sajolida over 3 years ago

  • Target version set to Tails_2.4

anonym: do you think you can do that for 2.4?

#43 Updated by anonym over 3 years ago

  • Assignee changed from anonym to sajolida
  • QA Check changed from Ready for QA to Dev Needed
  • Feature Branch changed from web/9323-replace-old-documentatweb/9323-replace-old-documentationion to web/9323-replace-old-documentation

sajolida wrote:

anonym: do you think you can do that for 2.4?

I think so, at least if you merge master into the feature branch and deal with the conflicts as you offered above.

#44 Updated by sajolida over 3 years ago

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

Oops, I should have done that when submitting for review. More conflicts might appear as people keep on translation the assistant, but we'll see.

#45 Updated by anonym over 3 years ago

  • Assignee changed from anonym to sajolida

I found these issues:

  • In config/chroot_local-includes/usr/share/doc/tails/website/install/download/openpgp.mdwn we have:
    - <!-- l10n placeholder for language-specific link -->
    

    and that actually generates an empty bullet point.
  • In the same file, three different desc styles are used for the Wikipedia ikiwiki shortcut, of which one actually writes a new one, which complicates translation. What is going on? Can't the desc be set consistently by the shortcuts (incl. the localized ones)? FTR, these differing styles are:
    • [[!wikipedia GnuPG desc="Wikipedia: %s"]]
    • [[!wikipedia Linux_User_Group desc="%s"]]
    • [[!wikipedia Web_of_Trust desc="Web of Trust"]]:
  • Same file again: I think we can remove the note about our key transition one year ago.
  • We now have levels of rewriting rules:
    wiki/src/.htaccess:RewriteRule ^doc/trusting_tails_signing_key doc/get/trusting_tails_signing_key [R]
    wiki/src/.htaccess:RewriteRule ^doc/get/trusting_tails_signing_key install/download/openpgp#wot [R,NE]
    

    Maybe it works (I have no clue), but perhaps they should be simplified so they all redirect directly to openpgp#wot.

So none of these are blockers so IMHO we should merge ASAP to avoid further blockers. There's already some so, sajolida, please merge and resolve conflicts yourself! :) Feel free to also fix the issues from the above that you think make sense. As long as you test them carefully and individually I don't think there has to be any review.

#46 Updated by sajolida over 3 years ago

  • In config/chroot_local-includes/usr/share/doc/tails/website/install/download/openpgp.mdwn we have:
    > - <!-- l10n placeholder for language-specific link -->
    > 

    and that actually generates an empty bullet point.

Yeah... that's an old trick I copied from the previous doc but I'll
remove it with 25ca34a now. For the sake of simplicity basically.

  • In the same file, three different desc styles are used for the Wikipedia ikiwiki shortcut, of which one actually writes a new one, which complicates translation. What is going on? Can't the desc be set consistently by the shortcuts (incl. the localized ones)? FTR, these differing styles are:
    • [[!wikipedia GnuPG desc="Wikipedia: %s"]]
    • [[!wikipedia Linux_User_Group desc="%s"]]
    • [[!wikipedia Web_of_Trust desc="Web of Trust"]]:

Fixed in eda47e0!

  • Same file again: I think we can remove the note about our key transition one year ago.

There are still people complaining about not having the right key, see
for example https://twitter.com/Tails_live/status/729759439306280961 so
I'll leave it for one more year maybe.

  • We now have levels of rewriting rules:
    > wiki/src/.htaccess:RewriteRule ^doc/trusting_tails_signing_key doc/get/trusting_tails_signing_key [R]
    > wiki/src/.htaccess:RewriteRule ^doc/get/trusting_tails_signing_key install/download/openpgp#wot [R,NE]
    > 

    Maybe it works (I have no clue), but perhaps they should be simplified so they all redirect directly to openpgp#wot.

Yes, this works but you're right that it makes sense to avoid chained
redirections. Done in e05fcd0 now.

Merging and fixing on the spot, then!

#47 Updated by sajolida over 3 years ago

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

Yeah!

Also available in: Atom PDF