kiwix / web

Bugs, enhancements, ideas for our Web presence
https://kiwix.org
7 stars 6 forks source link

Suggestions for more accurate labelling of download packages #217

Closed Jaifroid closed 1 year ago

Jaifroid commented 1 year ago

I love the Website refresh, which I've just noticed. But @Popolechien, I have some suggestions for more accurate labelling of download packages on https://kiwix.org/en/applications/. There's also no mention of the PWA here at all, which is quite a popular alternative, and users have asked us why we don't signal it as available on kiwix.org.

Here is the first suggestion (more to follow in subsequent comments):

image

Issues with above:

Kiwix JS PWA, Windows Store and Electron alternative (also supports older Windows)

Kiwix JS is a lightweight, installable Web app that works fully offline and has experimental support for reading Zimit archives. It can be used as an offline-first PWA simply by visiting https://pwa.kiwix.org (in Chrome/Edge, it can be installed as a first-class app). There is also a packaged Windows Store (UWP) version for Windows 10 or 11 tablets, phones, PC and Xbox, and Electron/NWJS binaries compatible with all 32bit and 64bit Windows versions XP/Vista/7/8/10/11.

Finally, I suggest adding a third button in this section, next to Electron: [ PWA ] linked to https://pwa.kiwix.org. You can get official PWA logos like the one below from https://github.com/webmaxru/progressive-web-apps-logo/issues/4

Jaifroid commented 1 year ago

For the Linux section, there is also no mention of the PWA or the Electron-based Linux packages. These are compatible with 32bit Linux OS too.

image

Here, I suggest adding a section similar to the one under Windows:

Kiwix JS PWA and Electron alternative (also supports 32bit Linux versions)

Kiwix JS is a lightweight, installable Web app that works fully offline and has experimental support for reading Zimit archives. It can be used as an offline-first PWA simply by visiting https://pwa.kiwix.org (in Chrome/Edge, it can be installed as a first-class app in Ubuntu, Debian, Fedora, etc.). There are also Electron-based binaries for 32bit and 64bit Linux (AppImage, deb, rpm).

And I suggest the following buttons for this section (using the same Electron and PWA logos):

[ Electron ] [ PWA ]

Jaifroid commented 1 year ago

image

Here, I think it would be enough simply to add a [ PWA ] button and logo without further comment.

Yes, the PWA can be installed as a first-class app with its own icon on Android, and offers the advantage of being able to pick any ZIM archive from virtually anywhere on the device. Users have asked why we don't make them aware of this option on the Web site.

Jaifroid commented 1 year ago

image

Here, we need a section like on Windows and Linux. The PWA can be installed on iOS (Safari) and macOS very well (see screenshots below) and it offers experimental support for reading Zimit archives.

I suggest:

Kiwix JS installable PWA with experimental Zimit support

Kiwix JS is a lightweight, installable Web app that works fully offline and supports most Zimit archives. It can be used as an offline-first PWA simply by visiting https://pwa.kiwix.org in Safari on iOS, or in any modern browser on macOS. For the best experience add to Home Screen in iOS or install it on macOS if using Chrome. It will get its own icon and run in a standalone window.

And I suggest just the [ PWA ] button for this section.

iOS montage

Jaifroid commented 1 year ago

image

The buttons here are wrongly linked. They point to the base app, not to WikiMed. Please correct the first one so that it points to https://www.microsoft.com/store/apps/9PHJSNP1CZ8J .

Please replace the second one with [ Electron ] (the permalink is https://kiwix.github.io/kiwix-js-windows/wikimed-electron.html).

And change the text as follows (I offer packages for Linux as well as Windows):

WikiMed for Linux and Windows

With 75,000+ medical articles, WikiMed is the largest and most comprehensive collection of health-related articles available in English. It includes content on diseases, medications, anatomy, and sanitation from Wikipedia. We offer Electron-based packages of WikiMed / MDWiki in English for 32bit and 64bit Linux (AppImage, deb) and Windows 7/8/10/11, and a convenient, self-updating Windows Store app (UWP) for Windows 10/11, including tablets, Xbox and phones. Other languages can be downloaded in the app.

Popolechien commented 1 year ago

@Jaifroid as you can see the linux and windows packages are now separate so we need to plan/label accordingly

Jaifroid commented 1 year ago

OK, then we need a separate entry for WikiMed Linux. It would basically be the same. as the Windows one, with slight editing.

Jaifroid commented 1 year ago

image

Both buttons are wrong here, and I don't do a separate Wikivoyage Europe. I just do the one full English Wikivoyage app.

Please correct the first button to point to https://www.microsoft.com/store/apps/9N5SB90Q4JBJ, and change the second one to: [ Electron ] - that's a permalink https://kiwix.github.io/kiwix-js-windows/wikivoyage-electron.html.

The text is fine, but I suggest adding at the end:

We offer Electron-based packages of full English Wikivoyage for 32bit and 64bit Windows 7/8/10/11, and a convenient, self-updating Windows Store app (UWP) for Windows 10/11, including tablets, Xbox and phones. Other Wikivoyage languages can be downloaded in the app.

We need a second entry for the Linux Wikivoyage packages. This can be the same as the Windows entry, but without the Windows Store button. The text at the end can read:

We offer portable and installable Electron-based packages of full English Wikivoyage for 32bit and 64bit Linux (AppImage, deb), tested on Ubuntu, Debian, Fedora and OpenSUSE. Other Wikivoyage languages can be downloaded in the app.

(This same text can be used for the Linux WikiMed entry, changing "Wikivoyage" to "WikiMed / MDWiki".)

kelson42 commented 1 year ago

We never have clearly advertised the PWA version AFAIK. I'm in favour of extending the "Browser extensions" to explain clearly what is is and what it allows.

Regarding the "Custom apps", the problem with it is that this is system centric in place of been content centric. We should have one box per content (so only one box for Wikimed for example), and then explain what we have for each system.

We need there to be extra carefuly in term of clarity. I'm not able myself to understand the subtilties beetween the different flavours @Jaifroid builds for custom apps. @Jaifroid Do you have on Github a clear explanation somewhere about the different kind of packages your provide?

Jaifroid commented 1 year ago

@kelson42 Sorry for hiatus, I didn't see your question at the end of comment. The app is simply published in different wrappers according to the OS it is published for. The packages are all listed in Releases: see https://github.com/kiwix/kiwix-js-windows/releases/tag/v2.6.4. To summarize:

Jaifroid commented 1 year ago

@Popolechien I realize this thread has become a bit convoluted. I'd say the most important initial change (because it's misleading) is this one: https://github.com/kiwix/web/issues/217#issue-1854649647.

Assuming you want to put the PWA in its own tile (I think that's the implicaiton of @kelson42's comment above), then these are the edits needed for the Windows tile:

Kiwix JS UWP and Electron (also supports older Windows)

Kiwix JS is a lightweight, installable Web app that works fully offline and has experimental support for reading Zimit archives. There is a packaged Windows Store (UWP) version for Windows 10 or 11 tablets, phones, PC and Xbox, and Electron/NWJS binaries compatible with all 32bit and 64bit Windows versions XP/Vista/7/8/10/11.

Jaifroid commented 1 year ago

Any updates? The Windows tile is still misleading, and the WikiMed and Wikivoyage packages for Linux are completely missing from our Web presence, as is any mention of the PWA...

Popolechien commented 1 year ago

Ok done so far:

Far from ideal, but I also agree that we have too many flavours and that the distinction isn't always very clear for the layperson (and that is un understatement). That is why I mostly left out the PWA for the time being.

What is left:

Jaifroid commented 1 year ago

Thank you! I'll take a look at w/e. Regarding permalinks, please hang on, as I'm renaming the Repository soon, and I think this will force the "perma" links to change. So will send you working ones when that's complete (also at w/e I think, or early next week, as I have some un-fun deadline on Sunday (!)).

Jaifroid commented 1 year ago

@Popolechien Here are the new Permalinks:

Please note that, as predicted, the old permalink to the Windows Electron app, currently on the "Kiwix for Windows" tile, is now broken (since the rename of kiwix-js-windows to kiwix-js-pwa, ), and needs to be replaced with the first link above. It would be ideal if you could also add that Electron link to the GNU/Linux tile, if that's not too much trouble (it's the same permalink for Linux and for Windows in each case, as it takes the user to the appropriate Release page where apps for both OS's are listed).

One final thing: there is no Wikivoyage Electron app for Android (Electron is not compatible with Android). The Electron button currently on the Wikivoyage for Android tile needs to be removed. Instead, there should be an Electron button (with the above new permalinks) on the Wikivoyage for Windows and WikiMed for Windows tiles (in addition to the current button to the MS Store).

Many thanks!

Jaifroid commented 1 year ago

The Progressive Web App (PWA) is not a Windows-only thing (this is why I've now renamed the kiwix-js-windows repo to kiwix-js-pwa, as it was misleading). It's universal, as any Web app should be: it works on Android, iOS, macOS, Linux and Windows, basically anywhere that a Chromium or Firefox browser can run..

So, if the PWA is not going to have its own tile, then it should appear on other relevant tiles, not only on the Windows tile. NB Don't confuse this with the Electron app: Electron is a framework for packaging a JS app for specific Operating Systems (desktop only).

Jaifroid commented 1 year ago

Regarding the text describing Kiwix JS on the Windows tile, thank you for simplifying it for a tech-naive audience! Here are some slight suggested tweaks, with insertions in italics, and deletions crossed out:

~Compatible With Older Versions (Windows XP, Vista, Etc.)~ Installable Web app (works on older Windows too)

Kiwix JS is a smaller alternative. It can be used as an offline-first Progressive Web App in your browser. There is a also a Windows Store (UWP) version for Windows 10 or 11 tablets, phones, PC and Xbox, and an Electron ~versions~ app compatible with ~older~ all Windows versions (XP, Vista, Win7/8/10/11) .

Jaifroid commented 1 year ago

This thread has become too convoluted and confusing, so I'll break down what remains to be done in different issues.