Shawn Heisey created SOLR-4901:
----------------------------------
Summary: Newcomer Curb Appeal - improve the Out Of Box experience
for new users
Key: SOLR-4901
URL: https://issues.apache.org/jira/browse/SOLR-4901
Project: Solr
Issue Type: Improvement
Components: documentation, web gui
Reporter: Shawn Heisey
This is a master issue to track improvements affecting a new user's experience
with Solr. Please link other issues, blocking this one.
Solr is immensely complex. When I first started using it, the initial learning
curve was incredibly steep. It's still uphill even now, but I mostly know
where the handrails are.
The general focus for linked issues:
1) Improving what the user sees when they first download Solr.
I think issues for this item will mostly be about the included txt files and
the wiki pages referenced there.
We want to be sure that the user who downloads Solr and looks at README.txt is
able to find information that will give them insight into how the Solr startup
works and what information is configured where. Any wiki pages referenced need
to be top quality, with introductions that really help a novice user and
advanced reference material for users with more experience.
The README should tell them how to get into the example's admin UI. Until we
improve the UI, IMHO it should set expectations about what kind of features
they'll get out of the UI and let them know that they'll probably be accessing
API URLs directly and editing config files.
Moving from the example in the download to a robust production installation,
especially for SolrCloud, should be in our documentation.
2) Improving the UI so the novice doesn't have to edit so many config files or
immediately learn how to use arcane HTTP API calls. Experienced users look at
these things and have no problem with them, but they are voodoo to the new user.
When using the UI to make changes (for example, CoreAdmin), the actual API URL
that was called should be available, and if it fails, helpful text and a wiki
link should be displayed so that the user can figure out what went wrong.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
