Opened 3 years ago

Closed 3 years ago

#2239 closed defect (fixed)

Fix up old console home page text (readme.html)

Reported by: zzz Owned by: slumlord
Priority: major Milestone: 0.9.36
Component: apps/console Version: 0.9.34
Keywords: Cc: sadie
Parent Tickets: Sensitive: no


and enable translation via transifex, using process we used for jetty help page #2214
cc: Sadie for general guidance. No reason we can't do this for .36.
File is installer/resources/readme/readme.html


#1401: Group or order the links on the Console "Home" page betterclosedsadie

Attachments (3)

readme.patch (31.2 KB) - added by Reportage 3 years ago.
Updated readme.html
help-troubleshoot.jsi (5.9 KB) - added by Reportage 3 years ago.
New help file for troubleshooting section
readme.html (18.3 KB) - added by slumlord 3 years ago.
First pass at readme.html update

Download all attachments as: .zip

Change History (16)

comment:1 Changed 3 years ago by slumlord

It is currently a terrifyingly long text. Outdated text and dead links can definitely be removed. There is lots of good information there, it could be presented in a manner that may improve a new user's ability to get a good overview of the information that is available - either hiding the text by default or shifting them to different pages or something else entirely. I wonder how many users make the effort to read the entire page.

Changed 3 years ago by Reportage

Attachment: readme.patch added

Updated readme.html

comment:2 Changed 3 years ago by Reportage

Attachment removes dead links, adds fresh links, removes the troubleshooting section (should be migrated to its own section on help) and various other tweaks.

Changed 3 years ago by Reportage

Attachment: help-troubleshoot.jsi added

New help file for troubleshooting section

comment:3 Changed 3 years ago by Reportage

Ideally the Help pages should be split to avoid browser/user overload, with associated sections on a single page eg. sidebar/configuration/reachability, and a context aware top navigation bar, with anchor links to the relevant sub-sections on the sidebar help section etc. Splitting the pages up affords the possibility of adding further sections without page overload, as is the case now.

comment:4 Changed 3 years ago by zzz

re: comment 3, wrong ticket. This ticket is about fixing and translating readme.html, not the help page.

comment:5 Changed 3 years ago by zzz

existing readme.html now pushed to the ztest transifex resource, just to see how it would look to translators

comment:6 Changed 3 years ago by zzz

Add a subticket #1401.

comment:7 Changed 3 years ago by slumlord

From a recent discussion with Sadie:

First thing we could do is to make the content of each section underneath the Welcome To I2P section collapsible/Hidden by default, i.e.

  • Welcome To I2P
    • This section is kept as-is

The following sections are made hidden by default, the sections headings are displayed with the content hidden behind a button that will toggle its visibility.

  • Services on I2P
  • Anonymous Encrypted Web Hosting on I2P
  • I2P-Hidden Services Of Interest
  • Troubleshooting & Further Assistance

Rationale behind this change would be to allow users to get a clear overview of the information that is present on the page where they can click through to read the content which they are interested in.

This may or may not be an improvement from an average user's perspective, I would like to hear thoughts/opinions on this.

comment:8 Changed 3 years ago by zzz

That would require JS skills we may not have. Additionally, the user may not have JS enabled.

At the bottom of i2psnark, the UI changes last year made the add/create sections hidden with some JS magic and we had several complaints of being unable to expand the sections on certain browsers. Not sure if it's completely fixed for everybody even now, so I'm wary of trying to replicate it on the console home page.

In any case, any fancy JS stuff can always be added later. The important thing is to fix up the content and prepare it for translation, if we're going to do this for 36 we need to get on this soon. Final version due by tag freeze, August 8.

comment:9 Changed 3 years ago by Reportage

The collapsible panels feature in I2Psnark doesn't use javascript at all, it uses checkbox icons and css.

Regarding certain browsers that don't play nicely with the feature, mitigations were introduced: excluding browsers by user agent, which can be updated in the source if there are other browsers that don't support the feature, and an UI option to disable the feature entirely.

For older versions of Qupzilla, the detection doesn't work because the user agent string for Qupzilla is "QupZilla?", so that's a simple fix in the source code. Newer versions of Qupzilla do support the feature, and Qupzilla has been rebranded as Falkon, which fully supports the feature.

As for the original OP, migrating the welcome page to /help, and reordering sections where appropriate is arguably a better idea than rejigging the text, with individual pages for different sections with a fully enabled .confignav to handle the different sub-pages.

The /console page could then present the user with a general overview of the console and webapps, displaying graphs, usage stats, and webapp information that presents the user with a summary of performance and activity.

comment:10 Changed 3 years ago by slumlord

Here's a first pass at readme.html


  • Tried to phrase things in a way that would be easily translatable.
  • Split up sentences to 1 a line instead of the whole paragraph on 1 line
  • Removed a few instances of forum.i2p and replaced with i2pforum.i2p
  • There's a number of Wikipedia links, do we really need those in there? Assuming that the reader/user is trying to sort out a problem/issue and in a hurry, they may not be interested in a visit to wikipedia
  • Removed external link to a website for port forwarding, possibly better to link to a post/guide on our forum and maintain that with appropriate links?

Changed 3 years ago by slumlord

Attachment: readme.html added

First pass at readme.html update

comment:11 Changed 3 years ago by zzz

I suggest you just check it in to trunk so it's easier for people to see it in the dev builds and others can work on it too. No need to do all the work here in the ticket.
Agreed that we don't need wikipedia links.

comment:12 Changed 3 years ago by sadie

agree, re: wikipedia links and links being changed if we can point to better and more up to date info. I am happy with this update for the upcoming release.

comment:13 Changed 3 years ago by zzz

Resolution: fixed
Status: newclosed

@slumlord assume we're done? closing… if there's more you want to do for 37 move the milestone and reopen

Note: See TracTickets for help on using tickets.