[
https://issues.apache.org/jira/browse/SOLR-14726?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17477321#comment-17477321
]
David Eric Pugh commented on SOLR-14726:
----------------------------------------
Thanks for pinging me [~ichattopadhyaya]. One thing that I have found in
working on the various Katas (structured training tutorials) over in Chorus is
that having more narrowly focused tutorials is much easier to reason about then
one long comprehensive tutorial.
I looked a bit at the proposed Ref Guide structure for 9, and I think I'd like
to see this tutorial retitled as "Solr in Five Minutes" tutorial, and linking
it from
https://nightlies.apache.org/solr/draft-guides/solr-reference-guide-main/introduction.html
as well as making it the first tutorial in the
https://nightlies.apache.org/solr/draft-guides/solr-reference-guide-main/solr-tutorial.html
page.
Then, we might find there is some content we could remove from the techproducts
one later if this tutorial covers it and we don't see more value...
> 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: Ishan Chattopadhyaya
> Priority: Major
> Labels: newdev
> Attachments: yasa-http.png
>
> Time Spent: 2h
> Remaining Estimate: 0h
>
> 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.20.1#820001)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org
For additional commands, e-mail: issues-h...@solr.apache.org
