Opened 5 months ago

Closed 4 months ago

#29440 closed task (fixed)

Update about:tor when Tor Browser is updated

Reported by: antonela Owned by: tbb-team
Priority: Medium Milestone:
Component: Applications/Tor Browser Version:
Severity: Normal Keywords: ux-team, tbb-update, TorBrowserTeam201903R, tbb-8.5
Cc: mcs, brade Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

As part of #25694, I suggested having "Tor Browser has been updated" as a title in about:tor when Tor Browser starts after an update.

The mockup is here
https://trac.torproject.org/projects/tor/attachment/ticket/25694/1.3C.jpg

For users interested in view the changelog, we should discuss if an exclusive page for it is the best way to approach it.

Child Tickets

Attachments (3)

about:changelog.jpg (315.3 KB) - added by antonela 4 months ago.
bug28440-about-tor.png (168.7 KB) - added by mcs 4 months ago.
about:tor after update
bug29440-about-tbupdate.png (236.5 KB) - added by mcs 4 months ago.
about:tbupdate (changelog)

Download all attachments as: .zip

Change History (27)

comment:1 Changed 5 months ago by gk

The mockup looks good to me. I think we could reuse our local Changelog page for the "View Changelog" item. That is, we could load that one instead of making a request to a remote page (which would need to be kept in sync with the Changelog we ship).

comment:2 in reply to:  1 ; Changed 5 months ago by antonela

Replying to gk:

The mockup looks good to me. I think we could reuse our local Changelog page for the "View Changelog" item. That is, we could load that one instead of making a request to a remote page (which would need to be kept in sync with the Changelog we ship).

Agreed! what is that url nowadays? We can style it to match the styleguide and we could be done. Do we have an .onion for it too?

comment:3 in reply to:  2 ; Changed 5 months ago by gk

Replying to antonela:

Replying to gk:

The mockup looks good to me. I think we could reuse our local Changelog page for the "View Changelog" item. That is, we could load that one instead of making a request to a remote page (which would need to be kept in sync with the Changelog we ship).

Agreed! what is that url nowadays? We can style it to match the styleguide and we could be done. Do we have an .onion for it too?

What do you mean? I was talking about _avoiding_ a remote URL and using a local one instead. Today we have about:tbupdate we could split that up and create a new URL, say, about:changelog or something for the "View Changelog" item.

comment:4 in reply to:  3 ; Changed 5 months ago by antonela

Replying to gk:

Today we have about:tbupdate we could split that up and create a new URL, say, about:changelog or something for the "View Changelog" item.

Sorry for the confusion, you are right. Having something like about:changelog is ideal. So, we can have the same layout we have in about:tor at about:tbupdate but with a new title.

And then, advanced (and curious) users can go deep on the changes clicking on View Changelog.

Do we need a mockup for about:changelog? is that markdown/markup?

Orthogonal: Do you think we need/should have a place to have it on our website? I think that could be useful to 1. have release notes outside the blog 2. have a centralized place to look for this notes.

Firefox have https://www.mozilla.org/en-US/firefox/64.0/releasenotes/

comment:5 in reply to:  4 ; Changed 5 months ago by gk

Replying to antonela:

Replying to gk:

Today we have about:tbupdate we could split that up and create a new URL, say, about:changelog or something for the "View Changelog" item.

Sorry for the confusion, you are right. Having something like about:changelog is ideal. So, we can have the same layout we have in about:tor at about:tbupdate but with a new title.

Yes, something like that.

And then, advanced (and curious) users can go deep on the changes clicking on View Changelog.

Do we need a mockup for about:changelog? is that markdown/markup?

Dunno. I have not thought about how fancy we want to have it. My first intuition is to just "cut out" what we have on about:tbupdate today and display it similarly on about:changelog...

Orthogonal: Do you think we need/should have a place to have it on our website? I think that could be useful to 1. have release notes outside the blog 2. have a centralized place to look for this notes.

Firefox have https://www.mozilla.org/en-US/firefox/64.0/releasenotes/

Yup, sounds like a good idea to me. Do you mind opening a ticket (bonus points for suggestions where on the website this should be shown. :) )?

comment:6 Changed 4 months ago by gk

Cc: mcs brade added
Keywords: TorBrowserTeam201903 added

comment:7 Changed 4 months ago by mcs

Status: newneeds_information

Kathy and I are starting to look at implementation for this ticket and we have a few UX questions:

  1. Should the post-update about:tor page that includes the Tor Browser has been updated text be displayed one time and one time only? We assume the answer is yes, but that does mean there will be no way for the user to return to that variation of about:tor once they close it or navigate away.
  2. Should we include the For the most up-to-date information about this release, visit our website. text and link on the new about:changelog page? Kathy and I think we should so that users can access that link in the future by opening about:changelog (after they close or navigate away from the post-update about:tor page).
  3. Should the top-right corner of about:tor always include the View Changelog link, or should that only be visible in the post-update about:tor page? Always including it seems preferable because that will provide a way for users to see the changelog later from within the browser.

comment:8 in reply to:  7 ; Changed 4 months ago by antonela

Replying to mcs:

Happy to have you both working on it :)

  1. Exactly, you right. One time and one time only. Next time they open the browser, or next time they open about:tor we should have the regular about:tor.
  1. Yes! about:changelog is the place where we are going to list change log lists. We discussed with Geko the possibility of including it in some place of the website. I owe that ticket. But, it is not related with this ticket scope. Maybe, that copy needs to be updated as well, since we are not going to link to the website, yet. Any suggestion?
  1. I think that we should include it always. Could we keep it?

Now my turn :)

Do you need a mockup for about:changelog? Is that html/markdown? Do you want to put the data there and could I work on the style? Let me know what is better for you.

Thanks!

Last edited 4 months ago by antonela (previous) (diff)

comment:9 in reply to:  5 Changed 4 months ago by antonela

Replying to gk:

Yup, sounds like a good idea to me. Do you mind opening a ticket (bonus points for suggestions where on the website this should be shown. :) )?

Done #29664, thanks!

comment:10 in reply to:  8 ; Changed 4 months ago by mcs

Status: needs_informationnew

Replying to antonela:

  1. Yes! about:changelog is the place where we are going to list change log lists. We discussed with Geko the possibility of including it in some place of the website. I owe that ticket. But, it is not related with this ticket scope. Maybe, that copy needs to be updated as well, since we are not going to link to the website, yet. Any suggestion?

The old about:tbupdate page links to the blog posting for the release. I think we can keep that for now. Since the URL is retrieved from a server during the update process, it will be easy to change it later if the website gains a nice changelog page.

  1. I think that we should include it always. Could we keep it?

Yes, will do.

Now my turn :)

Do you need a mockup for about:changelog? Is that html/markdown? Do you want to put the data there and could I work on the style? Let me know what is better for you.

I am not sure what kind of styling you have in mind, but the page is XHTML. Look here: https://gitweb.torproject.org/tor-browser.git/tree/browser/base/content/abouttbupdate?h=tor-browser-60.5.1esr-8.5-1 One of the current limitations is that the change log itself is extracted from a plain text file: the contents of the id="changelog" <div> within the aboutTBUpdate.xhtml file are replaced with the first portion of the following file: https://gitweb.torproject.org/builders/tor-browser-build.git/tree/projects/tor-browser/Bundle-Data/Docs/ChangeLog.txt

That means it will be difficult to apply different styles to different parts of the list of changes.

Changed 4 months ago by antonela

Attachment: about:changelog.jpg added

comment:11 in reply to:  10 ; Changed 4 months ago by antonela

Replying to mcs:

I am not sure what kind of styling you have in mind, but the page is XHTML.

Nothing too much complicated. Something close to:

https://trac.torproject.org/projects/tor/raw-attachment/ticket/29440/about%3Achangelog.jpg

Any monospace system font is elegant for the changelog copy. Then, you already have our brand font loaded. What do you think?

comment:12 Changed 4 months ago by antonela

Do you think this is a good place to ask for feedback / report a bug too? If yes, should we link users to our contact page?

https://lektor-staging.torproject.org/tpo/staging/contact/

comment:13 in reply to:  11 Changed 4 months ago by mcs

Replying to antonela:

Replying to mcs:

I am not sure what kind of styling you have in mind, but the page is XHTML.

Nothing too much complicated. Something close to:

https://trac.torproject.org/projects/tor/raw-attachment/ticket/29440/about%3Achangelog.jpg

Any monospace system font is elegant for the changelog copy. Then, you already have our brand font loaded. What do you think?

Given our current process, it seems risky to depend too much on the format of the ChangeLog.txt file (we would need to parse it to pull the version and release date into separate fields). But we will try to style the page in a way that is similar to what you propose.

comment:14 in reply to:  12 ; Changed 4 months ago by mcs

Replying to antonela:

Do you think this is a good place to ask for feedback / report a bug too? If yes, should we link users to our contact page?

https://lektor-staging.torproject.org/tpo/staging/contact/

I am not sure if the about:changelog page is a good place for that link. about:tor seems like a better place, and in fact we already have the Tor Browser Manual link there. Maybe we should make sure the manual includes info on how to get help and how to report a bug.

comment:15 in reply to:  14 Changed 4 months ago by antonela

Replying to mcs:

I am not sure if the about:changelog page is a good place for that link. about:tor seems like a better place, and in fact we already have the Tor Browser Manual link there. Maybe we should make sure the manual includes info on how to get help and how to report a bug.

Yep, good idea. Thanks!

comment:16 Changed 4 months ago by gk

Keywords: tbb-8.5 added

Tickets on our radar for 8.5

Changed 4 months ago by mcs

Attachment: bug28440-about-tor.png added

about:tor after update

Changed 4 months ago by mcs

Attachment: bug29440-about-tbupdate.png added

about:tbupdate (changelog)

comment:17 Changed 4 months ago by mcs

We have completed the implementation now. Tor Browser does not have the Source Sans Pro font, so we cannot use it. Should that be the subject of a new ticket?

I will link to patches in a moment, but here is what the about:tor page looks like:
https://trac.torproject.org/projects/tor/raw-attachment/ticket/29440/bug28440-about-tor.png

And here is the changelog page (we kept the URL as about:tbupdate so that long time users do not need to learn a new URL):
https://trac.torproject.org/projects/tor/raw-attachment/ticket/29440/bug29440-about-tbupdate.png

comment:18 Changed 4 months ago by mcs

Keywords: TorBrowserTeam201903R added; TorBrowserTeam201903 removed
Status: newneeds_review

There are two tor-browser commits on our bug29440-01 branch; the first one reverts the change that added the "New Circuit Display" banner to about:tbupdate, and the second commit implements the changes needed for this ticket:
https://gitweb.torproject.org/user/brade/tor-browser.git/log/?h=bug29440-01

There are also two torbutton patches (one to remove the strings that were added for the "New Circuit Display" banner, and one to implement the about:tor enhancements):
https://gitweb.torproject.org/user/brade/torbutton.git/log/?h=bug29440-01

comment:19 in reply to:  17 Changed 4 months ago by antonela

Replying to mcs:

We have completed the implementation now. Tor Browser does not have the Source Sans Pro font, so we cannot use it. Should that be the subject of a new ticket?

No, I think we can stick with system fonts.

It looks awesome, thanks for this implementation!!!

comment:20 Changed 4 months ago by gk

Do we have a way to just show the "View Changelog" link on the release and alpha series where there actually is a Changelog? Right now, I see it in the testbuild as well showing me "Tor Browser tbb-nightly" (which is okay for now, even though we might want to use "nightly" in the future) and the link to the Changelog. Clicking on it, however, gets me the changes for 8.5a8 which is confusing ("Hey, I am a nightly build user, why do I get the alpha Changelog link?").

comment:21 in reply to:  20 ; Changed 4 months ago by mcs

Replying to gk:

Do we have a way to just show the "View Changelog" link on the release and alpha series where there actually is a Changelog?

Good question. We could omit the ChangeLog.txt file from the nightly builds and then modify the about:tor code to check that such a file exists (and hide the "View Changelog" link if not). But it seems simplest to just check the update channel, so we revised our Torbutton patch to take that approach. Please test (and review) using the two torbutton patches that are on our bug29440-02 branch:
https://gitweb.torproject.org/user/brade/torbutton.git/log/?h=bug29440-02

comment:22 in reply to:  21 ; Changed 4 months ago by gk

Replying to mcs:

Replying to gk:

Do we have a way to just show the "View Changelog" link on the release and alpha series where there actually is a Changelog?

Good question. We could omit the ChangeLog.txt file from the nightly builds and then modify the about:tor code to check that such a file exists (and hide the "View Changelog" link if not). But it seems simplest to just check the update channel, so we revised our Torbutton patch to take that approach. Please test (and review) using the two torbutton patches that are on our bug29440-02 branch:
https://gitweb.torproject.org/user/brade/torbutton.git/log/?h=bug29440-02

Works for me.

Two final questions (I think :) ):

1) What's the reason for having

+        m_tb_prefs.clearUserPref(kShouldNotifyPref);

in the Torbutton patch? What is the scenario you are worried about here that makes you clearing the user pref?

2) What is "tor-right" in "include in the tor-right corner" in the Torbutton commit message? Did you mean "upper-right"? (If so, what about RTL bundles)

comment:23 in reply to:  22 ; Changed 4 months ago by mcs

Replying to gk:

Two final questions (I think :) ):

1) What's the reason for having

+        m_tb_prefs.clearUserPref(kShouldNotifyPref);

in the Torbutton patch? What is the scenario you are worried about here that makes you clearing the user pref?

We need to clear that pref so that the post-update variation of the about:tor page is only shown once.

2) What is "tor-right" in "include in the tor-right corner" in the Torbutton commit message? Did you mean "upper-right"? (If so, what about RTL bundles)

Apparently I have been thinking about "tor" too much. That was supposed to read "top-right" but in any case you are correct to question it. In an RTL browser it will be on the left. I fixed the commit message on the following branch (which contains the same two patches as before):
https://gitweb.torproject.org/user/brade/torbutton.git/log/?h=bug29440-03

comment:24 in reply to:  23 Changed 4 months ago by gk

Resolution: fixed
Status: needs_reviewclosed

Replying to mcs:

Replying to gk:

Two final questions (I think :) ):

1) What's the reason for having

+        m_tb_prefs.clearUserPref(kShouldNotifyPref);

in the Torbutton patch? What is the scenario you are worried about here that makes you clearing the user pref?

We need to clear that pref so that the post-update variation of the about:tor page is only shown once.

Right, I can see now why, thanks.

2) What is "tor-right" in "include in the tor-right corner" in the Torbutton commit message? Did you mean "upper-right"? (If so, what about RTL bundles)

Apparently I have been thinking about "tor" too much. That was supposed to read "top-right" but in any case you are correct to question it. In an RTL browser it will be on the left. I fixed the commit message on the following branch (which contains the same two patches as before):
https://gitweb.torproject.org/user/brade/torbutton.git/log/?h=bug29440-03

:)

Thanks for the patches, nice work! I merged them to tor-browser-60.5.1esr-8.5-1 (commits 681eefdd4234007f4984dd88abc2dfe10cbc2740 and 0c7bd3b2fa73e8be38f5aac46cbc68d025071f05) and Torbutton's master brach (commits d45e7f502c05101660e77d430d939582728952f2 and 82a5f8665a6b5a7f5d4c78f0a526dfa16834ec7f).

Note: See TracTickets for help on using tickets.