Feature #10734

Inconsistent titles in overviews

Added by sajolida 2015-12-09 06:21:54 . Updated 2016-08-17 00:07:17 .

Status:
Resolved
Priority:
Normal
Assignee:
Category:
Installation
Target version:
Start date:
2015-12-09
Due date:
% Done:

20%

Feature Branch:
web/10734-title-consistency
Type of work:
End-user documentation
Blueprint:

Starter:
Affected tool:
Installation Assistant
Deliverable for:

Description

We currently have:

  1. “Install from windows” which lacks a capital letter on Windows
  2. "Install from Linux (Red Hat, Fedora, etc.) which is not underlined consistently with others
  3. “Install from Debian” which doesn’t mention Ubuntu
  4. “Mac: burn a DVD and then install” which doesn’t follow the same structure as all the other ones
  5. meta title="Other Linux (Red Hat, Fedora, etc.) inconsistent with h1
  6. meta title=“Debian (& Ubuntu, Linux Mint, etc.)” inconsistent with h1

It might also be worth check how much these titles are consistent with their corresponding scenarios.

Assigned to tchou who wrote this code originally.


Files


Subtasks


Related issues

Blocked by Tails - Bug #10953: Document Tails Installer in Jessie backports Resolved 2016-01-16

History

#1 Updated by sajolida 2015-12-09 09:35:00

  • Description updated

#2 Updated by sajolida 2015-12-09 09:35:43

  • Description updated

#3 Updated by tchou 2015-12-14 08:44:31

Before commiting:

- please have a look in the spreadsheet. I try to summarize the current state of title in any steps (read it from left to right it’s button => title of the next page => button…). Say me if you are ok with my proposal.

- I propose a overview or steps in the titles : it can be elsewhere too (like in the last overview compacted). The point is to keep the same title with a overview/step difference somewhere

- I think we must use consistant title styling in steps (I already did a trick to differenciate it from all the other h1 in the step pages)

- I assume that h1 and title are the same

#4 Updated by tchou 2015-12-14 08:54:21

  • Feature Branch set to web/10734-title-consistency

#5 Updated by tchou 2015-12-14 08:54:58

I pushed the “Assistant styled titles in steps” trick.

#6 Updated by sajolida 2015-12-16 10:40:31

  • Target version changed from Tails_1.8 to Tails_2.0

#7 Updated by sajolida 2015-12-17 07:07:51

  • Description updated
  • Assignee changed from sajolida to tchou
  • QA Check changed from Ready for QA to Dev Needed

Some comments on your spreadsheet:

  • “Mac (DVD method)” makes it less clear that the DVD is not the final objective. I’m afraid you’re changing things here that were not problematic during the testing but without a clear benefit in my opinion.
  • You’re removing “Tails” and “on a USB stick” from titles in general. I’m OK with that.
  • You’re adding “: steps” in the title from steps. I don’t think that’s useful as the fact that we are coming from an “overview” and the content and the structure of the page make it pretty clear that these are the instructions. And this has not been pointing out as problematic during the tests.
  • I’m not convinced by “Install from Debian or Ubuntu (command line and gnupg method)” which is not really shorter than “Install from Debian or Ubuntu using the command line and GnuPG”

Then regarding your branch. I’m really against duplicating more [[!meta title into <h1>. The only reason to do so in the router and the overview was to be able to put some parts of the titles in bold. That’s a minor benefit that I consented to have to the price of information duplication on some pages. This very ticket proves that we already failed at maintaining consistent titles across this duplication (see my points 5 and 6). I also understand how highlighting words my help sometimes, but I don’t think that’s any useful in the title of the steps where people already went through two other pages that told them what the scenario was about (the router and the overview).

If you want to use the same CSS styling in the steps as in the router and overview that’s fine with me, but then please do this using the span.title selector.

#8 Updated by sajolida 2016-01-05 17:48:22

#9 Updated by tchou 2016-01-19 00:07:16

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

I did a first implementation, even if we have stuffs to discuss.

sajolida wrote:
> Some comments on your spreadsheet:
>
> * “Mac (DVD method)” makes it less clear that the DVD is not the final objective. I’m afraid you’re changing things here that were not problematic during the testing but without a clear benefit in my opinion.

There is something I don’t get. You say me that the previous version is not good because it “doesn’t follow the same structure as all the other ones” and now that I change it trying to find and follow a structure, you say “I’m afraid you’re changing things here that were not problematic”. What do we do ?

> * You’re removing “Tails” and “on a USB stick” from titles in general. I’m OK with that.
ok.

> * You’re adding “: steps” in the title from steps. I don’t think that’s useful as the fact that we are coming from an “overview” and the content and the structure of the page make it pretty clear that these are the instructions. And this has not been pointing out as problematic during the tests.

It as been pointed that some people at the overview where thinking that it was the step, so I think it’s good to have a difference between the 2 pages titles (or sub-titles). I think this question will be solved in the overview styling branch, but regarding titles, I used the shema:
- “the name of the scenario: overview” in the

<p>- and “the name of the scenario” in the</p> <h1> <p>.</p> <p>> * I’m not convinced by “Install from Debian or Ubuntu (command line and gnupg method)” which is not really shorter than “Install from Debian or Ubuntu using the command line and GnuPG”</p> <p>I did not felt that the point was not shorten things. Regarding your comments in the description, I understood it was more about consistency.</p> </div> </div> <div id="change-52641" class="journal has-details"> <div id="note-10"> <h4> <a href="#note-10" class="journal-link">#10</a> Updated by <span class="user active">sajolida</span> <a title='2016-01-20 18:12:52 ' data-ts='1453313572'>2016-01-20 18:12:52 </a> </h4> <ul class="details"> <li><strong>blocked by</strong> <i><del><a class='issue tracker-1 status-3 priority-5 priority-default closed child' href='/code/issues/10953' title='Document Tails Installer in Jessie backports'>Bug #10953</a></del>: Document Tails Installer in Jessie backports</i> added</li> </ul> </div> </div> <div id="change-52886" class="journal has-details"> <div id="note-11"> <h4> <a href="#note-11" class="journal-link">#11</a> Updated by <span class="user active">sajolida</span> <a title='2016-01-26 18:29:13 ' data-ts='1453832953'>2016-01-26 18:29:13 </a> </h4> <ul class="details"> <li><strong>Priority</strong> changed from <i>Normal</i> to <i>Elevated</i></li> <li><strong>Target version</strong> changed from <i>Tails_2.0</i> to <i>Tails_2.2</i></li> </ul> <p>Postponing and raising priority.</p> </div> </div> <div id="change-53143" class="journal has-details"> <div id="note-12"> <h4> <a href="#note-12" class="journal-link">#12</a> Updated by <span class="user active">sajolida</span> <a title='2016-01-29 18:17:26 ' data-ts='1454091446'>2016-01-29 18:17:26 </a> </h4> <ul class="details"> <li><strong>Parent task</strong> deleted (<del><i><del><a class='issue tracker-2 status-3 priority-5 priority-default closed child' href='/code/issues/8592' title='Release the installation assistant'>Feature #8592</a></del></i></del>)</li> </ul> </div> </div> <div id="change-55103" class="journal has-details"> <div id="note-13"> <h4> <a href="#note-13" class="journal-link">#13</a> Updated by <span class="user active">sajolida</span> <a title='2016-03-07 15:12:44 ' data-ts='1457363564'>2016-03-07 15:12:44 </a> </h4> <ul class="details"> <li><strong>Target version</strong> deleted (<del><i>Tails_2.2</i></del>)</li> </ul> </div> </div> <div id="change-55647" class="journal has-details"> <div id="note-14"> <h4> <a href="#note-14" class="journal-link">#14</a> Updated by <span class="user active">sajolida</span> <a title='2016-03-19 19:39:57 ' data-ts='1458416397'>2016-03-19 19:39:57 </a> </h4> <ul class="details"> <li><strong>Assignee</strong> changed from <i>sajolida</i> to <i>tchou</i></li> <li><strong>Priority</strong> changed from <i>Elevated</i> to <i>Normal</i></li> </ul> <p>I pushed a bunch more commits with 41e772b..c62f902. Tell if I can merge.</p> </div> </div> <div id="change-56031" class="journal has-details"> <div id="note-15"> <h4> <a href="#note-15" class="journal-link">#15</a> Updated by <span class="user active">sajolida</span> <a title='2016-04-01 10:33:00 ' data-ts='1459506780'>2016-04-01 10:33:00 </a> </h4> <ul class="details"> <li><strong>blocks</strong> <i>#8538</i> added</li> </ul> </div> </div> <div id="change-59013" class="journal has-details"> <div id="note-16"> <h4> <a href="#note-16" class="journal-link">#16</a> Updated by <span class="user active">BitingBird</span> <a title='2016-06-29 05:57:31 ' data-ts='1467179851'>2016-06-29 05:57:31 </a> </h4> <ul class="details"> <li><strong>Status</strong> changed from <i>Confirmed</i> to <i>In Progress</i></li> <li><strong>% Done</strong> changed from <i>0</i> to <i>20</i></li> </ul> </div> </div> <div id="change-60230" class="journal has-details"> <div id="note-17"> <h4> <a href="#note-17" class="journal-link">#17</a> Updated by <span class="user active">tchou</span> <a title='2016-08-15 03:47:26 ' data-ts='1471232846'>2016-08-15 03:47:26 </a> </h4> <ul class="details"> <li><strong>Assignee</strong> changed from <i>tchou</i> to <i>sajolida</i></li> <li><strong>QA Check</strong> deleted (<del><i>Ready for QA</i></del>)</li> </ul> <p>ok</p> </div> </div> <div id="change-60322" class="journal has-details"> <div id="note-18"> <h4> <a href="#note-18" class="journal-link">#18</a> Updated by <span class="user active">sajolida</span> <a title='2016-08-17 00:07:17 ' data-ts='1471392437'>2016-08-17 00:07:17 </a> </h4> <ul class="details"> <li><strong>Status</strong> changed from <i>In Progress</i> to <i>Resolved</i></li> <li><strong>Assignee</strong> deleted (<del><i>sajolida</i></del>)</li> </ul> </div> </div> </div> <div style="clear: both;"></div> <div class="contextual"> </div> <div style="clear: both;"></div> <div style="clear:both;"></div> </div> </div> </div> <div id="footer"> <div class="bgl"><div class="bgr"> Powered by <b>redlab</b>, static rendering of <a href="https://www.redmine.org/">Redmine</a> </div></div> </div> </div> </div> </body> </html>