Brainstorms on a Future UI

Background Info: Why are we brainstorming this (again) now?

Establishment of DSpace Governance

• In 2014, DuraSpace helped the DSpace project establish it's first DSpace Steering Group. While initially "appointed", going forward this Steering Group will be elected.  They now control the allocation of funds donated to DSpace (and the DSpace Tech Lead reports to them).
• In 2015, DuraSpace helped the DSpace project establish it's first DSpace Leadership Group. This Leadership Group is a larger group of community key stakeholders (primarily representing institutions who are also DuraSpace Members who have given money to the DSpace project). The Leadership Group will elect future Steering Group members, and they also represent the broad DSpace community and can vote to accept/reject any proposals from the Steering Group, Committers or DCAT. (NOTE: This group is still in the process of being formed)
• The Steering Group's role is to "ask the right questions" and make general suggestions for how the DSpace product may wish to move forward. They will work directly with Committers and DCAT to actually help answer those questions (Committers are still the primary DSpace technology decision makers, and DCAT is still the primary DSpace "use case" decision makers).
• One of the first questions that the Steering Group has asked is essentially: "Why are we shipping DSpace with two User Interfaces again?  Doesn't that split up our resources significantly and make it harder to develop for DSpace? We should think about consolidating to one UI."

Questions this Brainstorm seeks to help answer

So, the question(s) this page is trying to brainstorm include:

1. Why are we shipping DSpace with two UIs (JSPUI & XMLUI)?  Are there any advantages to doing so?
2. Should we consolidate into a single UI?
3. If the answer to consolidation is "yes", what UI should we consolidate under?  Should we just ship with the JSPUI? Should we just ship with the XMLUI?  Or should we build a new, modern replacement UI and ship with that?

Resources & Timeline

• Assuming we did decide to rebuild/rewrite one of our existing UIs, or even build a new UI, how would we get enough resources (i.e. developers) to do this in a timely manner?
  • If we decided to revamp or build a new UI, the Committers can recommend that to DSpace Steering.  Assuming Steering approves, they would ask the Leadership group to vote on the idea. 
  • If the Leadership group votes to approve the idea, then the Steering & Leadership would seek out the necessary resources to make this happen. 
  • As some of the institutions represented on Steering & Leadership have DSpace developers (or even Committers) on staff, the hope would be that they would donate some developer time to help achieve our goals in a timely manner.
• When would this happen? What is the timeline?
  • There are NO set timelines for this decision as of yet. It's merely a brainstorm to get a sense of what the developers and Committers feel may be the best direction forward.
  • Tim Donohue will be updating the Steering Group on this discussion as it progresses, and if any timelines are set, the entire community will be informed.

Other Questions?

If you have other questions which are not answered here, please feel free to ask them (either paste them in this section, or email Tim Donohue)

Multiple UIs vs One UI

Why are we shipping DSpace with two UIs (JSPUI & XMLUI)?  Are there any advantages to doing so?

Before deciding on a future direction for the DSpace UI(s), we have to face up to the "elephant in the room". We currently are building, maintaining and supporting two UIs (JSPUI & XMLUI) under a single Committers group.

Therefore, in order to move forward, we must make a decision on whether this direction is the best one for DSpace.  As such, here's some pros/cons to multiple vs single UIs...(feel free to add your own)

Possible Benefits of Multiple UIs

• Choice: Having multiple UIs provides users & developers with a choice. They can choose which UI better fits their needs or their local technology expertise.
• Competition: Having multiple UIs provides friendly competition between UI developers. As one UI makes improvements / enhancements, it encourages the other to do the same (or risk losing users to the "better" UI).

Possible Disadvantages of Multiple UIs

• Developer Resources: Building, supporting & maintaining two UIs essentially requires twice as many developer resources. If the community is large enough (which arguably DSpace is), there may be enough developers to support this. However, this becomes less maintainable when a single Committers group is expected to be knowledgeable enough on both UIs to support/build/maintain both simultaneously.  Two UIs really requires two committers teams (one specifically devoted to each UI).

Possible Benefits of a Single UI

• Developer Resources: Obviously, one UI requires less developer resources to build, support and maintain.
• Easier to "Roadmap": It is much easier to plan out a long term roadmap/plan for DSpace if we have a single UI which all features must integrate into. It becomes harder to plan out features that must be supported in multiple UI frameworks / infrastructures

Possible Disadvantages of a Single UI

• One UI technology must rule them all : Can we all come together to decide on a common technology framework that actually will meet all our needs?  Or are there actually separate needs / use cases that warrant the building of distinct UIs (similar to Hydra project)

Should we consolidate into a single, out-of-the-box UI?

Given the benefits and disadvantages above, one thing seems abundantly obvious: We cannot reasonably expect to continue supporting two UIs with a single Committers team. Or to restate that, it is unreasonable to expect any Committer (who are all volunteers, working at their own jobs) to be well versed enough to support, maintain, develop and review fixes for multiple UIs simultaneously.  This is an obvious misuse of the volunteer resources provided. Each institution has already made their own personal decision on which UI they wish to use, yet we are essentially forcing some institution's developers (e.g. Committers) to also be knowledgable on the other UI (which they never use on a day to day basis).

Given this, it only seems reasonable to also conclude:

• Conclusion: Our DSpace Committers group can only reasonably build/support/maintain a single, out-of-the-box DSpace UI.
  • Please note this does NOT state there should only be ONE UI (as noted above there are some advantages to multiple UIs).  It simply states that there will only be one out-of-the-box UI.  
  • If there are enough developers/institutions who see an ongoing need for a secondary UI, they are welcome to build, support and maintain a secondary, optional UI with their own, separate group of developers/committers.
    • A sidenote of sorts: If a secondary "committers group" were to form around a secondary UI, it may someday make sense to "split" the "DSpace Committers Group" into several "sub-teams":  One team in charge of the underlying API / REST API, one team in charge of the primary, out-of-the-box UI, one team in charge of the secondary UI (if any).  These teams would likely have some overlapping members, but they'd each be self-sufficient and more tailored to the needs of each individual sub-modules.
• Opinions? Please feel free to add +1 / 0 / -1 to this conclusion, and any comments you may have
  • I AGREE: We only should maintain a single, out-of-the-box DSpace UI. If a secondary UI is built (or continues to be maintained), it should be maintained by a separate team of committers / developers (and therefore become a separate project or organization in GitHub).
    • +1 Tim Donohue
    • +1 Bram Luyten (Atmire)
    • (add your name here, if you agree with the above conclusion. Feel free to also add additional thoughts/comments)
  • I DISAGREE: We should continue to support/maintain multiple out-of-the-box DSpace UIs with our existing DSpace Committers Team
    • (add your name here, if you disagree with the above conclusion. Feel free to also add additional thoughts/comments)

What makes a good UI (framework)?

The following is a list of features/needs which we feel would make a good User Interface / User Interface framework.  Since not all of these features/needs would have the same importance, we've categorized some as "required", "recommended" or "optional".

1. Open Source (required): Obviously. Also we need to avoid GPL and similar licenses which are incompatible with BSD.
2. Easy to run "out-of-the-box" (required): in keeping with DSpace Vision, any UI or UI framework must be easy to get running "out-of-the-box".
   
3. Ease of UI Customization (required): a UI should be relatively easy to customize for institutions. At a minimum, institutions should be able to easily swap out the header/footer/color scheme of the default UI. Ideally, the UI would support third-party themes (e.g. Bootstrap themes from http://bootswatch.com/ or similar) which can be easily applied to the UI to change its entire look and feel.
4. Responsive Web Design (required) : a UI should be responsive, adapting to the size of various devices.
   1. Bootstrap support (recommended): Ideally, the UI would support Bootstrap, since it is one of the most widely used and supported responsive frameworks
5. HTML5 Support (required): a UI should be able to support HTML5.  Ideally, it is built primarily with HTML5 in mind, rather than only supporting some aspects of HTML5.
6. REST API friendly (highly recommended): a UI should be built with the idea of "separation of concerns".  For example, the UI framework should include NO business logic or Database query logic, etc. It should also have no knowledge of the underlying storage framework (e.g. Database schemas, file storage locations, etc).  Instead, ideally it would  communicate with DSpace primarily through the REST API (and other similar layers, e.g. Solr or Elastic Search). It would NEVER communicate directly with the database or other underlying storage layers.
7. Faceted/Filtered Search/Browse friendly (highly recommended):  a UI should easily integrate with a faceted/filtered search engine/server (such as Solr pr Elastic Search) or a generic API which can communicate with said faceted/filtered search engine (e.g. Discovery, Blacklight)
8. Rapid Development support / Developer friendly (highly recommended): a UI should be easy to develop against and improve upon. Ideally in a popular technology or language.  Local developers should not need to go through extensive training to work with the UI. The framework and technology ideally should be widely used, so that newer developers can also quickly come up to speed.  (Some examples: Ruby on Rails is a popular widely used technology/language. As is, seemingly, the Java Play! framework. Both are obviously much more widely used and easier to develop with than say Apache Cocoon)
9. Active, third party plugin ecosystem (highly recommended): a UI framework should ideally come with an active plugin/module/tool ecosystem. This is not only the sign of a strong community around the UI framework, but also eases the development burden on DSpace developers, as we no longer need to build all features specific to DSpace.  (For example, a UI framework that came with its own, third-party Authentication plugins would allow us to utilize that rather than building our own plugins for Shib/LDAP, etc)
10. Standard way of dealing with i18n (required): DSpace has multiple international language communities who each manage their own set of translations for the interfaces. Migration from the current way of managing these translations to the new framework should be possible. Contribution of new translations should not be more difficult than it is today.
11. Java-friendly (recommended): DSpace's underlying framework & API will always be Java. There are no plans to completely rewrite DSpace. However, this does NOT mean the UI needs to also be written in Java, but it may be best that the UI technology is Java-friendly or even in a language that is similar to or based off Java (e.g. Javascript, Groovy, even Ruby is similar enough).

UI framework options / analysis

Here's a few possible UI frameworks which we may wish to analyze for a single future UI.  A much larger listing of various web application frameworks appears on Wikipedia: https://en.wikipedia.org/wiki/Comparison_of_web_application_frameworks

Please feel free to add more that you feel would be worth analyzing for DSpace!