[
https://issues.apache.org/jira/browse/SOLR-14726?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17183619#comment-17183619
]
Alexandre Rafalovitch commented on SOLR-14726:
----------------------------------------------
After some - very productive - discussion, I think I can summarize my
objections as following:
# I feel very strongly that the beginner tutorial should start with a
standalone mode, as that presents a smaller comprehension surface, especially
when random things go wrong. I do feel that the cloud example should be
documented somewhere as well, but not as a first contact. To me, this removes
the following items from the critical path:
## bin/solr start -e cloud (in fact, I believe the creation script combined
with bin/solr has enough corelated magic to not be reproducible exactly by
hand, specifically the logs directories inside the example path)
## Using V2 API - as that does not work in standalone and is possibly still
unfinished
## Making it less verbose - I think switching the example to the cloud is what
made it verbose in all the wrong places
# I feel the examples should be more coherent but not removed, therefore:
## Yes on removing films (which no longer allows to get a larger dataset)
## Yes on removing techproducts and associated files (I feel it is very out of
date)
## Yes (unasked) on removing all the DIH examples as we are getting rid of DIH
## Yes (my own) on introducing a new dataset, possibly split into different
formats to demonstrate all the features other datasets used to demonstrate
For the other things, I feel they are hard to discuss without actually trying
to prototype them. E.g. post tool has a lot of magic, we can switch to curl but
would we then have to explain a lot of that magic every time? Or will it make
our own hidden issues more clear (JSON endpoints!)? Docker requires us owning
that container creation (do we?). Notebooks are cool idea.
> Streamline getting started experience
> -------------------------------------
>
> Key: SOLR-14726
> URL: https://issues.apache.org/jira/browse/SOLR-14726
> Project: Solr
> Issue Type: Task
> Reporter: Ishan Chattopadhyaya
> 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
