Skip to main content

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.

Jump to: navigation, search

Difference between revisions of "Equinox/p2/User Interface"

< Equinox‎ | p2
(Additional Requirements)
 
(136 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__TOC__
+
This page provides links to the various design and discussion documents surrounding the p2 User Interface.
  
== Provisioning UI Overview ==
+
== Workflows ==
There are currently two flavors of provisioning UI under development. To complicate matters, you can configure your workspace to run both at the same time if you desire.
+
* [[Equinox p2 UM workflows]] summarizes the Eclipse 3.3 Update Manager scenarios
 +
* [[Equinox p2 UI 3.4 workflows]] summarizes the goals for the Eclipse 3.4 (p2) Update UI. It includes scenarios and compares click counts to the 3.3 UI.
 +
* [[Equinox p2 UI 3.5 workflows]] provides mockups for proposed changes in 3.5
  
* The end user UI appears as a new menu item '''Software Updates (Incubation)...''' in the help menu of your eclipse application.  To include this UI in your eclipse application, you want to include the plug-in '''org.eclipse.equinox.prov.ui.sdk''' in your launch.
+
== Design discussions ==
* The admin UI appears as either a perspective in your Eclipse launch, or as a stand-alone RCP app.  The intention of this UI is to help the team develop, test, and use the provisioning infrastructure. Thus the UI exposes the underlying infrastructure and associated terminology to the end user, which is definitely not the approach we expect to take for end users.  To include this UI, you want to include the plug-in '''org.eclipse.equinox.prov.ui.admin''' in your launch, or else run the RCP version of the app using the launch in '''org.eclipse.equinox.prov.ui.admin.rcp'''.
+
* [[Equinox p2 UIWG Walkthrough|p2 UIWG First Walkthrough]] includes the both the prep info and the minutes from the 6/25/2008 walkthrough of the p2 UI at the UIWG.
* Note that if you enable the sdk UI in a launch of the admin UI, you can operate the admin UI and still launch the end-user UI using the menu item in the help menu.  If you do this, you will notice multiple property pages for repositories and IU's, one with developer/implementation info, and the other with more end-user info.
+
* [[Equinox p2 UI Use Cases]] includes discussion of user personas, important user scenarios, and discussion of changes that may be necessary in the 3.5 p2 UI
 +
*[[Equinox/p2/UIWG Walkthrough 2|p2 UIWG Second Walkthrough]] includes the prep info for the 10/1/2008 walkthrough of the p2 UI at the UIWG
  
===Plugin Structure===
+
== Development Plans ==
* '''org.eclipse.equinox.prov.ui''' contains code we think is useful for any SWT/JFace-based provisioning UI.
+
* [[Equinox p2 UI Plan]] contains the working plan for the UI current release
** Content and label providers for showing provisioning objects in views
+
* [[Equinox p2 UI Eclipse 3.4 Plan]] contains milestone plans from the 3.4 release
** View filtering
+
** Widget groups for creating/editing provisioning objects
+
** Common drag/drop adapters with pluggable prompting
+
** Pluggable update and install UI  
+
** Issues not addressed yet
+
*** Easier pluggability of terminology and graphics for IU's, Profiles, Repos
+
*** Scalability issues - lazy content providers for repo access (iteration vs. collection)
+
*** consider UI forms vs. dialogs
+
*** Input validators for provisioning info (repo URLs, capabilities, touchpoint types, etc.)
+
*** Automatic checking for available updates with pluggable notification style
+
  
* '''org.eclipse.equinox.prov.ui.sdk''' contains the update manager replacement UI.  You'll see terminology such as "feature" and "site" used in this UI.
+
== Testing ==
* '''org.eclipse.equinox.prov.ui.admin''' is the current developer/administrator UI.
+
* [[Equinox/p2/UI Manual Tests]] contains the UI manual tests
* '''org.eclipse.equinox.prov.ui.rcp''' is an RCP application of the admin UI
+
  
=== Eclipse SDK UI ===
+
== How-to's ==
Different workflows will drive the development of this UI.  The first priority is to deliver the equivalent functionality of the current Update Manager UI.  Note that we are not saying we are solving all of these problems.  Part of defining the workflow may be saying that we aren't addressing it yet. 
+
* [[Equinox/p2/Adding Self-Update to an RCP Application]]
* User is looking for a specific software component to add to their environment
+
** Simple install
+
*** user browses repositories for software to install/update
+
*** UI precomputes info such as required software, download size/time, etc
+
*** user accepts licenses, etc.
+
** Install requires updating (or downgrading) of existing components
+
** Conflicts arise in the requirements for various components
+
* Software updating
+
** User looks for updates of software already installed
+
** User wants automatic checking/notification of available updates
+
** Silent/automatic updating
+
* User wants to remove a software component from their environment
+
** Simple uninstall
+
** Associated uninstall of required software
+
** How much does the user care about complete rollback (downgrading components that were upgraded by an install, etc.)
+
* User wants to know what software is available for download (browse, search by function or name, etc.)
+
* User's environment is defined explicitly by someone external (administrator)
+
** Upgrade or install to a new specification
+
** Compare current installation to required one
+
* User wants to return to some previously known state (rollback to a named state)
+
  
 
+
[[Category:Equinox p2|User Interface]]
=== Admin UI ===
+
The following items are planned for the current provisioning admin UI
+
* General UI polish issues
+
** increased use of progress dialogs
+
** persisting user choices (view expansions, etc.)
+
** more flexible work flows (create a new profile from profile chooser, etc.)
+
** configurable label providers to control what is seen in various views
+
 
+
== Milestone plan ==
+
* M2
+
** Install, Uninstall, and/or update IU's from running profile
+
*** [done] user views installed IU's in the current profile
+
*** [done] user can manage repositories as an advanced feature (separate button on dialog)
+
**** [done] repositories are colocated (no distinction between metadata and artifact repo)
+
*** UI prequalifies the install
+
**** [done] figure out if the install is valid using oracle
+
**** [deferred] use advanced oracle to flag any invalid states
+
**** [deferred] use advanced oracle to precompute info such as download size/time, etc.
+
*** [done] user can uninstall an installed IU
+
*** user can update an installed IU
+
** Repository naming (at the repo and user level)
+
** [done] Better filtering of repos and IU's (show only what's relevant to end user)
+
** [done] Refactor drag support into common UI project
+
** [done] Filtering of IU's based on entry point concept
+
*** [done] Give the ability to name what is being installed
+
** [done] Admin UI can launch end user UI from selected profile in profile view
+
*** [done] should be able to disable colocated repo management
+
** [done] AdminUI views show enhanced info about objects (multiple columns)
+
** [done] AdminUI and User UI contribute different property pages
+
 
+
== Additional Requirements ==
+
Here are some requirements that have surfaced so far.  They are not added in a milestone plan yet.
+
 
+
* [deferred from M2] notify user of invalid state that might be created by a proposed install (requires advanced oracle)
+
* [deferred from M2] precompute download size/time (requires advanced oracle)
+
* Silent/automatic update checking
+
* Use engine query infrastructure for content providers rather than view filtering
+
* Improved way to present licenses
+
* Remember accepted licenses
+
* Installation by drag and drop on a running eclipse
+
* Automatic installation
+
* Asynch/lightweight notification of need to update
+
* Ability to defer the install (remind me later...)
+
* Ability to update to a new version of a base and keep other plug-ins
+
* Ability to install from other eclipse installs on the machine
+
* Install from a click on the webpage
+
* Silent installation
+
* Support installation even when there are errors in the configuration
+
* Admin/tooling
+
** Repo management tools
+
** Defining and persisting profiles for mass deployment to users
+
 
+
== Past milestone plans ==
+
* M1
+
** Browse repositories
+
*** Add/remove repositories
+
*** Browse IU's in a metadata repository
+
*** Install IU from a metadata repository into a selected profile
+
** Browse profiles
+
*** Add/remove profiles
+
*** Browse IU's in a profile
+
*** Uninstall IU 
+
[[Category:Equinox|Provisioning]]
+
[[Category:Provisioning|User Interface]]
+

Latest revision as of 15:30, 3 January 2011

This page provides links to the various design and discussion documents surrounding the p2 User Interface.

Workflows

Design discussions

  • p2 UIWG First Walkthrough includes the both the prep info and the minutes from the 6/25/2008 walkthrough of the p2 UI at the UIWG.
  • Equinox p2 UI Use Cases includes discussion of user personas, important user scenarios, and discussion of changes that may be necessary in the 3.5 p2 UI
  • p2 UIWG Second Walkthrough includes the prep info for the 10/1/2008 walkthrough of the p2 UI at the UIWG

Development Plans

Testing

How-to's

Back to the top