Mailing-List: contact ooo-commits-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: ooo-dev@incubator.apache.org
Date: Mon, 21 May 2012 20:06:00 -0400 (EDT)
From: confluence@apache.org
To: ooo-commits@incubator.apache.org
Message-ID: <24182493.65051.1337645160068.JavaMail.confluence@thor>
Subject: [CONF] Apache OpenOffice Community > Improvements for the download
 webpages
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
Auto-Submitted: auto-generated

Space: Apache OpenOffice Community (https://cwiki.apache.org/confluence/dis=
play/OOOUSERS)
Page: Improvements for the download webpages (https://cwiki.apache.org/conf=
luence/display/OOOUSERS/Improvements+for+the+download+webpages)

Change Comment:
---------------------------------------------------------------------
Sorted table: new things on top, resolved things on bottom

Edited by Marcus Lange:
---------------------------------------------------------------------
{toc}

h2. Immediate Concerns, Short Term Improvements

The following tasks need to be done to improve the download webpages:

|| Desciption || File || Issue ID || Owner || Target || Status ||
| Chrom browser provide different platform data in "navigator.platform" and=
 "navigator.userAgent" (i686 and x86_64), so it's not possible to handle th=
is in our DL magic (see issue IDs for update). | download/download.js | Goo=
gle \\
[44905 | http://code.google.com/p/chromium/issues/detail?id=3D44905] \\
[128167 | http://code.google.com/p/chromium/issues/detail?id=3D128167] \\
[117524 | http://trac.webkit.org/changeset/117524] \\
[86778 | https://bugs.webkit.org/show_bug.cgi?id=3D86778] | ? | ? | Waiting=
 for Google's bugfix |
| In the green box, present a respective text to the user that a download i=
s not possible for the platform / language combination. Check the platform =
and language if a build is available. Example: \\ \\ Download Apache OpenOf=
fice 3.4.0 \\ A release for <platform> and <language> is not available. Ple=
ase choose from the alternative download webpage for another build. | downl=
oad/index.html \\ download/download.js | -- | marcus | AOO 3.4.1 | New |
| Extend the list of known/unknown platforms with others from the old error=
 webpage for MirrorBrain. | download/download.js | -- | marcus | AOO 3.4.1 =
| New |
| Integrate links to localized release notes into the download webpages. | =
download/index.html \\ download/others.html | -- | marcus | AOO 3.4.1 | New=
 |
| Implement hints for the "other_print.html". \\ \\ Kay: empty line between=
 the "download" and the checksum links (add another <br />). | download/tes=
t/print_table_aoo.js | -- | marcus | AOO 3.4.1 | New |
| Move all script files into an own "scripts/" subdir. | download/\*.js \\ =
download/\*.css | -- | marcus | AOO 3.4.1 | New |
| Cleanup the "download/" directory. | download/* | -- | marcus | AOO 3.4.1=
 | New |
| Extended the logic to recognize Chromium browser to create download URL w=
ith deb or rpm package. | download/download.js | -- | ? | ? | New |
| Separate the DL logic for ASF, SF and MB mirror systems into own files to=
 get a better overview where is what located. \\ {color:#ff0000} \[not sure=
 this is needed - Kay] \\
\[right, when all logic is in single file local variables can be used all o=
ver the place, clearly better - Marcus\] {color} | download/*.js | -- | ? |=
 AOO 3.4.1 | New |
| Attempt to put getLink() and hasMirror() in main page body with variable =
assignments to eliminate duplicate calls during processing. | download/*.js=
 | -- | kschenk | AOO 3.4.1 | New |
| Use version name and schema name to generate pack names to eliminate the =
long "if" statements. | download/*.js | -- | kschenk | AOO 3.4.1 | New |
| Set download directory names for any language based on version and mirror=
. Use in conjunction with name and schema for accessing installs -- providi=
ng complete path to mirrors. | download/index.html \\ download/*.js | -- | =
kschenk/marcus | AOO 3.4.1 | New |
| Refactor *.js files to cull out unused routines. | download/*.js | -- | ?=
 | AOO 3.4.1 | New |
| Create the table with download links automatically with parameters. | dow=
nload/other.html | -- | marcus | AOO 3.4.1 | {highlight:yellow} In Progress=
 {highlight} \\
[other_print.html | http://www.openoffice.org/download/test/other_print.htm=
l] \\
[globalvars_print.js | http://www.openoffice.org/download/test/globalvars_p=
rint.js] \\
[print_table_aoo.js | http://www.openoffice.org/download/test/print_table_a=
oo.js] |
| Add the checksum links into the automatically created table. | download/o=
ther.html | -- | marcus | AOO 3.4.1 | {highlight:yellow} In Progress {highl=
ight} \\
[other_print.html | http://www.openoffice.org/download/test/other_print.htm=
l] \\
[globalvars_print.js | http://www.openoffice.org/download/test/globalvars_p=
rint.js] \\
[print_table_aoo.js | http://www.openoffice.org/download/test/print_table_a=
oo.js] |
| In the green box, name clearly the Linux package that will be downloaded.=
 Example: \\  \\
Click to start downloading the most recent version for Linux <32-bit =E2=94=
=82 64-bit> <DEB =E2=94=82 RPM> and English (US) | download/index.html down=
load/download.js | -- | marcus | shortly after AOO 3.4.0 | {highlight:green=
} Resolved {highlight} |
| Extended the logic to recognize "IceWeasel" to create download URL with d=
eb package. | download/download.js | -- | marcus | shortly after AOO 3.4.0 =
| {highlight:green} Resolved {highlight} |
| Make the redirect for not-supported languages (like en-GB) work again | d=
ownload/index.html | [119357|https://issues.apache.org/ooo/show_bug.cgi?id=
=3D119357] | marcus | shortly after AOO 3.4.0 | {highlight:green} Resolved =
{highlight} |
| In the sub-green box, shorten the text to make space for links to checksu=
m files directly. Example: \\ \\
[Other Platforms and Languages|http://www.openoffice.org/download/other.htm=
l] =E2=94=82 [Legacy OOo Version|http://www.openoffice.org/download/legacy/=
index.html] =E2=94=82 [Release Notes|http://www.openoffice.org/development/=
releases/AOO3.4.0.html] =E2=94=82 Signatures and Hashes: (Link to ASC), (Li=
nk to MD5), (Link to SHA1), (Link to SHA512) =E2=94=82 [Verify your downloa=
d with checksums|http://www.openoffice.org/download/checksums.html#howto] |=
 download/index.html \\ download/download.js | -- | marcus | AOO 3.4.1 | {h=
ighlight:green} Resolved {highlight} |
| Delete all stuff that has to do with Bouncer. | download/*.js | -- | marc=
us | AOO 3.4.1 | {highlight:green} Resolved {highlight} |
| Delete all stuff that has to do with file name schema "old". These have t=
he structure that was needed for Bouncer and is now no longer needed. | dow=
nload/*.js | -- | marcus | AOO 3.4.1 | {highlight:green} Resolved {highligh=
t} |
| Delete all stuff that has to do with offering JRE builds. This will simpl=
ify making script work for all 3.x versions. | download/*.js | -- | marcus =
| AOO 3.4.1 | {highlight:green} Resolved {highlight} |
| Delete the additional JS file and make sure that all is still working. | =
download/download2.js | -- | marcus | AOO 3.4.1 | {highlight:green} Resolve=
d {highlight} |
| Delete all stuff that has to do with the old download and webtracking | d=
ownload/download.js \\ download/download_mirrorbrain.js | -- | marcus | AOO=
 3.4.1 | {highlight:green} Resolved {highlight} |
| Delete all stuff that has to do with offering JRE and Mac builds. | downl=
oad/languages.js | -- | marcus | AOO 3.4.1 | {highlight:green} Resolved {hi=
ghlight} |
| Extend the lanuages with the native name (to ease the translation of the =
"index.html" webpage for the NL community) | download/index.html \\ downloa=
d/languages.js | -- | marcus | AOO 3.4.1 | {highlight:green} Resolved {high=
light} |
| Toggle all sites in languages.js with jre to 'n' and investigate Mac sett=
ing for each. \\ {color:#ff0000}\[IMHO we should simply delete the columns =
for JRE and Mac as it's no longer needed - Marcus\] {color} | download/lang=
uages.js | -- | kschenk/marcus | AOO 3.4.1 | {highlight:green} Resolved {hi=
ghlight} |
| Cleanup the "download/test" subdir. \\
{color:#ff0000}=EF=BB=BF \[see comments\] {color} | download/test/* | -- | =
kschenk/marcus ? | AOO 3.4.1 | {highlight:green} Resolved {highlight} |
| Delete legacy MD5sums files from "download/" as they are already in the "=
legacy/" subdir. | download/md5sums/ \\
download/legacy/md5sums/ | -- | marcus | shortly after AOO 3.4.0 | {highlig=
ht:green} Resolved {highlight} |
| Integrate the dev builds / nightly builds into the download webpages, ref=
er to the [Wiki page|https://cwiki.apache.org/confluence/display/OOOUSERS/A=
OO+3.4+Unofficial+Developer+Snapshots] instead to create new download links=
 | download/index.html | -- | marcus | AOO 3.4.1 | {highlight:green} Resolv=
ed {highlight} |
| Extend the getLink() function to accept a specific ISO code to get forced=
 to build a download URL for a specific language (and not only recognize th=
e ISO code by "navigator.language") to allow localized download webpages on=
 the several NL websites | download/index.html \\
download/download.js \\ download_mirrorbrain.js | -- | marcus | AOO 3.4.1 |=
 {highlight:green} Resolved {highlight} |

h2. Is the download working correctly for specific Linux + platform + brows=
er combinations?

|| Linux  || Package Manager || Platform || Browser || Correct download || =
Status ||
| Fedora | RPM | x86 | Firefox | {highlight:green} Yes {highlight} | |
| Fedora | RPM | x86_86 | Firefox | {highlight:green} Yes {highlight} | |
| Fedora | RPM | x86 | Chrom | {highlight:green} Yes {highlight} | |
| Fedora | RPM | x86_86 | Chrom | {highlight:red} No {highlight} | Browser =
doesn't provide the correct platform value, see item in table above, x86 wi=
ll be used |
| openSUSE | RPM | x86 | Firefox | {highlight:green} Yes {highlight} | |
| openSUSE | RPM | x86_86 | Firefox | {highlight:green} Yes {highlight} | |
| openSUSE | RPM | x86 | Chrom | {highlight:green} Yes {highlight} | |
| openSUSE | RPM | x86_86 | Chrom | {highlight:red} No {highlight} | Browse=
r doesn't provide the correct platform value, see item in table above, x86 =
will be used
| Debian | DEB | x86 | IceWeasel | {highlight:green} Yes {highlight} | |
| Debian | DEB | x86_86 | IceWeasel | {highlight:green} Yes {highlight} | |
| Debian | DEB | x86 | Chrom | {highlight:red} No {highlight} | Browser doe=
sn't provide a recognizable value to differentiate between RPM and DEB, RPM=
 will be used |
| Debian | DEB | x86_86 | Chrom | {highlight:red} No {highlight} | Browser =
doesn't provide a recognizable value to differentiate between RPM and DEB, =
RPM will be used \\ Browser doesn't provide the correct platform value, see=
 item in table above, x86 will be used |
| Ubuntu | DEB | x86 | IceWeasel | {highlight:green} Yes {highlight} | |
| Ubuntu | DEB | x86_86 | IceWeasel | {highlight:green} Yes {highlight} | |
| Ubuntu | DEB | x86 | Chrom (from distro) | {highlight:green} Yes {highlig=
ht} | |
| Ubuntu | DEB | x86_86 | Chrom (from distro) | {highlight:red} No {highlig=
ht} | Browser doesn't provide the correct platform value, see item in table=
 above, x86 will be used |
| Ubuntu | DEB | x86 | Chrom (from Google) | {highlight:red} No {highlight}=
 | Browser doesn't provide a recognizable value to differentiate between RP=
M and DEB, RPM will be used |
| Ubuntu | DEB | x86_86 | Chrom (from Google) | {highlight:red} No {highlig=
ht} | Browser doesn't provide a recognizable value to differentiate between=
 RPM and DEB, RPM will be used \\ Browser doesn't provide the correct platf=
orm value, see item in table above, x86 will be used |
| Ubuntu | DEB | x86 | Opera | {highlight:red} No {highlight} | Browser doe=
sn't provide a recognizable value to differentiate between RPM and DEB, RPM=
 will be used |
| Ubuntu | DEB | x86_86 | Opera | {highlight:red} No {highlight} | Browser =
doesn't provide a recognizable value to differentiate between RPM and DEB, =
RPM will be used \\ Browser doesn't provide the correct platform value, see=
 item in table above, x86 will be used |

h2. Design Overhaul -- why we need it

h5. Current State

* Client is identified for OS, OS variant, language with JS (navigator.plat=
form, navigator.user-agent).
* Package for client is provided based on a schema and a mirror location in=
 JS -- globalvars.js
combined with a package naming, SCHEMA (for the desired version), client's =
language, and whether that client is available from the standard mirror
or elsewhere.
* Language, package locations, and other variables (most no longer used) ar=
e defined as a JS array in languages.js.

h5. Current state -- problems.

* The languages array now contains fields that are no longer used.
* The languages array is setup with majors of some languages, i.e. "en", wi=
th a cumbersome structure of sub-versions.
* As new language translations are added as standard to the mirror reposito=
ry, the languages.js must be edited to reflect this.
* As new versions are provided, a change to the SCHEMA variable must be mad=
e.
* The current file structure on the mirrors for the distribution -- "stable=
" vs "localized" makes it difficult to easily collect download statistics.
* The internal logic in the ".js" files -- download.js , and download_mirro=
brain.js -- is fairly cumbersome and circuitous, making it difficult to asc=
ertain results for more complicated cases, lack of navigator.platform, non-=
identifiable language, etc.
* Manual editing is needed to properly construct package names depending on=
 the SCHEMA for the version.
* Due to so much manual editing, mistakes are likely.
* It's basically impossible to proved the same set of js scripts for each v=
ersion we might want to provide to the client.

h5. Current state -- good aspects.

* So far, it mostly works.

h2. Design Overhaul -- Ideas for Retooling

* A means to generate an XML feed from the package build process that would=
 provide information (existence) for each language/platform. This file woul=
d need to be concatenated with the existng XML file and saved in www.openof=
fice.org/download. Older versions no longer provided could be easily elimin=
ated. An entry indicating mirror name would need to be provided in this tre=
e as well. {color:#ff0000}Additional details will follow.{color}
This would eliminate manual editing to control much of the DL process.
* Retool much of the js scripts to process the XML file, checking for the e=
xistence of the desired version w/language.

Change your notification preferences: https://cwiki.apache.org/confluence/u=
sers/viewnotifications.action