Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "UX/IDE"
(Created page with "{{warning|Work in progress. This page is concerned with capturing user experience plans for Eclipse-based IDE in Mars}} =Download= =Installation= ==Windows== ==Mac== ==Lin...") |
(→Simple Mode) |
||
(14 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | {{warning|Work in progress. This page is concerned with capturing user experience | + | {{warning|Work in progress.}} |
+ | |||
+ | This page is concerned with capturing user experience requirements for Eclipse-based IDE packages in Mars. | ||
=Download= | =Download= | ||
Line 5: | Line 7: | ||
==Windows== | ==Windows== | ||
+ | |||
+ | ===Via Installer=== | ||
+ | Download the installer, <code>eclipse-installer.exe</code> | ||
+ | |||
+ | Double-click to launch. | ||
+ | |||
+ | Automatically unpacks, configures itself, and updates as necessary. | ||
+ | |||
+ | If a JRE cannot be found, provide help so that the user can download an install an appropriate JVM. Give preference to Java 8. | ||
+ | |||
+ | Starts in "simple" mode. | ||
+ | |||
+ | ====Simple Mode==== | ||
+ | {{warning|The diagrams here are intended to provide a technology-agnostic overview of the potental workflow/storyboard of the installation experience.}} | ||
+ | |||
+ | [[File:Installer-Workflow.gif|thumb|Simple installer workflow (click to see animation)]] | ||
+ | # Select a "base" package definition<br/>[[File:Installer-Packages.png|400px]] | ||
+ | # Configure default preferences (see {{bug|421702}})<br/>[[File:Installer-Preferences.png|400px]] | ||
+ | # Specify location, launcher, desktop icon (with reasonable defaults)<br/>[[File:Installer-Launcher.png|400px]] | ||
+ | # Ask user to register an Eclipse Foundation account (optional)<br/>[[File:Installer-Register.png|400px]] | ||
+ | # Click "Finish" | ||
+ | |||
+ | After installation, installer quits and all temporary files are removed (only the <code>exe</code> remains). | ||
+ | |||
+ | Review the [https://github.com/eclipselabs/prototype.installer installer UI workflow prototype] on EclipseLabs. | ||
+ | |||
+ | ====Advanced Mode==== | ||
+ | * Select a package definition | ||
+ | * Select a workspace configuration | ||
+ | * Allow customization of every setting | ||
+ | * Configure default preferences | ||
+ | * Ask user if an icon should be added to the desktop | ||
+ | * Ask user to register an Eclipse Foundation account (optional) | ||
+ | |||
+ | ====Launching==== | ||
+ | |||
+ | The installer adds a standard launch entry/icon to the start menu and (optionally, based on the user's selection during installation) the desktop (see {{bug|459589}}). | ||
+ | |||
+ | Notes: | ||
+ | |||
+ | * Remember user state; e.g. if the user switches to advanced mode, open in that mode on subsequent launches | ||
+ | * The preferences configuration should be a single page (or a small number of pages with groups of preferences) | ||
+ | ** The first time through, the changes made by the user to the defaults is retained | ||
+ | ** On subsequent launches, the user should be given the option (on by default) to override their defaults with changed values (only if there are changes) | ||
+ | * Remember if the user has already registered for an account; don't ask again | ||
+ | |||
+ | ====Bundle Pools==== | ||
+ | |||
+ | By default, all installations use bundle pools. This can only be turned off in advanced mode. | ||
+ | |||
+ | The bundle pool currently manifests as a <code><i>USER_HOME</i>/.p2</code> directory. The average user attaches no meaning to "p2"; should the bundle pool be placed under <code><i>USER_HOME</i>/.eclipse</code> by default? (see {{bug|461049}}). | ||
+ | |||
+ | ====Questions==== | ||
+ | * Is there value in asking a user to "login" if they already have an account? | ||
+ | ** Not sure if there is value in logging in during installation | ||
+ | * What is the default install location? | ||
+ | * What about shared installs? | ||
+ | ** Are we only concerned with user-specific installation? | ||
+ | |||
+ | ===Via Packages=== | ||
+ | The standard packages download is available as an option. | ||
+ | |||
+ | The old limitation of the build-in decompression software in Windows failing on the long file names in our package downloads is still an issue. | ||
+ | |||
+ | Use a robust decompression software package to decompress the package download into the directory of choice. | ||
+ | |||
+ | Double-click on the eclipse.exe to launch. | ||
==Mac== | ==Mac== | ||
==Linux== | ==Linux== | ||
+ | ===Via Fedora Software Repository=== | ||
Use standard Linux software repositories to install official release versions of Eclipse (see {{bug|442591}}). | Use standard Linux software repositories to install official release versions of Eclipse (see {{bug|442591}}). | ||
Line 19: | Line 89: | ||
<code>yum update eclipse-jdt ...</code> | <code>yum update eclipse-jdt ...</code> | ||
− | + | ===Via Packages=== | |
− | Download | + | Download installation/configuration tool from the eclipse.org website. There is no native executable so the download must be unpacked and executed. |
− | * Consider adding the | + | * Consider adding the installer to the Fedora repository. |
=Welcome= | =Welcome= | ||
+ | |||
+ | =Adding Features= | ||
+ | |||
+ | Add features via the Eclipse Marketplace and Simultaneous Release Catalogue (see {{bug|459905}}). |
Latest revision as of 11:45, 3 March 2015
This page is concerned with capturing user experience requirements for Eclipse-based IDE packages in Mars.
Contents
Download
Installation
Windows
Via Installer
Download the installer, eclipse-installer.exe
Double-click to launch.
Automatically unpacks, configures itself, and updates as necessary.
If a JRE cannot be found, provide help so that the user can download an install an appropriate JVM. Give preference to Java 8.
Starts in "simple" mode.
Simple Mode
- Select a "base" package definition
- Configure default preferences (see bug 421702)
- Specify location, launcher, desktop icon (with reasonable defaults)
- Ask user to register an Eclipse Foundation account (optional)
- Click "Finish"
After installation, installer quits and all temporary files are removed (only the exe
remains).
Review the installer UI workflow prototype on EclipseLabs.
Advanced Mode
- Select a package definition
- Select a workspace configuration
- Allow customization of every setting
- Configure default preferences
- Ask user if an icon should be added to the desktop
- Ask user to register an Eclipse Foundation account (optional)
Launching
The installer adds a standard launch entry/icon to the start menu and (optionally, based on the user's selection during installation) the desktop (see bug 459589).
Notes:
- Remember user state; e.g. if the user switches to advanced mode, open in that mode on subsequent launches
- The preferences configuration should be a single page (or a small number of pages with groups of preferences)
- The first time through, the changes made by the user to the defaults is retained
- On subsequent launches, the user should be given the option (on by default) to override their defaults with changed values (only if there are changes)
- Remember if the user has already registered for an account; don't ask again
Bundle Pools
By default, all installations use bundle pools. This can only be turned off in advanced mode.
The bundle pool currently manifests as a USER_HOME/.p2
directory. The average user attaches no meaning to "p2"; should the bundle pool be placed under USER_HOME/.eclipse
by default? (see bug 461049).
Questions
- Is there value in asking a user to "login" if they already have an account?
- Not sure if there is value in logging in during installation
- What is the default install location?
- What about shared installs?
- Are we only concerned with user-specific installation?
Via Packages
The standard packages download is available as an option.
The old limitation of the build-in decompression software in Windows failing on the long file names in our package downloads is still an issue.
Use a robust decompression software package to decompress the package download into the directory of choice.
Double-click on the eclipse.exe to launch.
Mac
Linux
Via Fedora Software Repository
Use standard Linux software repositories to install official release versions of Eclipse (see bug 442591).
On Fedora:
yum install eclipse-jdt eclipse-cdt eclipse-egit
and
yum update eclipse-jdt ...
Via Packages
Download installation/configuration tool from the eclipse.org website. There is no native executable so the download must be unpacked and executed.
- Consider adding the installer to the Fedora repository.
Welcome
Adding Features
Add features via the Eclipse Marketplace and Simultaneous Release Catalogue (see bug 459905).