[
https://issues.apache.org/jira/browse/SOLR-14726?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17434889#comment-17434889
]
Ishan Chattopadhyaya commented on SOLR-14726:
---------------------------------------------
bq. Why is the PR against 8x repo and not main?
I wish to fix documentation for 8x first, since most users are on 8x. Users
won't likely use 9x for quite some time now, and I see no reason to retain the
current "Solr tutorial" for even a minute longer. If needed, I can volunteer to
go back to each and every 8x release branch, commit the getting started there,
manually build a ref-guide (with Cassandra's help, if she's game) and put it
up. No user should be able to land on an official "Solr tutorial" (for any
version of Solr) that makes Solr look ancient and difficult to use, let alone
mislead and misguide them.
I'll tackle the 9x guide after the 8x one is done, since there's going to be
some changes due to schema guessing being removed.
bq. I realize the getting-started may look different in 9.0 if we remove the
add-fields-to-schema from _default. Then users will need to explicitly make a
schema prior to indexing the first document, while in 8x you can do some simple
examples with the guessing logic.
Lets discuss more on this during the removal of schema guessing. The 9x getting
started can look different from the 8x one.
> 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.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org
For additional commands, e-mail: issues-h...@solr.apache.org
