[
https://issues.apache.org/jira/browse/SOLR-14726?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17185889#comment-17185889
]
Alexandre Rafalovitch commented on SOLR-14726:
----------------------------------------------
I absolutely agree on First Contact being very smooth and hopefully show the
power of Solr very quickly (which means good example dataset in the box). To
me, however, this means standalone start as it just requires less moving parts
and things to explain (e.g. Collection vs Core in Admin UI).
At the same time, it is important to recognize that users who are new to Solr
(or any complex product) may make easy mistakes very early on. If we don't give
them equally easy way to troubleshoot, they may never get to the step 4. That
again points away from cloud for the initial contact because, for example, if
we ask them to run a config API command to update schema definition, they could
see if that managed-schema has been rewritten or not. In the cloud, it is much
harder. These checkpoints are quite important I feel and I am always annoyed by
the tutorials that just give you step after step and you don't know if you
mistyped something at step 2 or step 10.
Also step 6 is mostly outside of this ticket's scope, apart from solving the
issue that default configuration is currently so hard to read that people take
that into production, however many warnings we put in the middle of a
thousand-line file.
> Streamline getting started experience
> -------------------------------------
>
> Key: SOLR-14726
> URL: https://issues.apache.org/jira/browse/SOLR-14726
> Project: Solr
> Issue Type: Task
> Reporter: Ishan Chattopadhyaya
> Assignee: Alexandre Rafalovitch
> Priority: Major
> Labels: newdev
> Attachments: yasa-http.png
>
>
> The reference guide Solr tutorial is here:
> https://lucene.apache.org/solr/guide/8_6/solr-tutorial.html
> It needs to be simplified and easy to follow. Also, it should reflect our
> best practices, that should also be followed in production. I have following
> suggestions:
> # Make it less verbose. It is too long. On my laptop, it required 35 page
> downs button presses to get to the bottom of the page!
> # First step of the tutorial should be to enable security (basic auth should
> suffice).
> # {{./bin/solr start -e cloud}} <-- All references of -e should be removed.
> # All references of {{bin/solr post}} to be replaced with {{curl}}
> # Convert all {{bin/solr create}} references to curl of collection creation
> commands
> # Add docker based startup instructions.
> # Create a Jupyter Notebook version of the entire tutorial, make it so that
> it can be easily executed from Google Colaboratory. Here's an example:
> https://twitter.com/TheSearchStack/status/1289703715981496320
> # Provide downloadable Postman and Insomnia files so that the same tutorial
> can be executed from those tools. Except for starting Solr, all other steps
> should be possible to be carried out from those tools.
> # Use V2 APIs everywhere in the tutorial
> # Remove all example modes, sample data (films, tech products etc.),
> configsets from Solr's distribution (instead let the examples refer to them
> from github)
> # Remove the post tool from Solr, curl should suffice.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
