Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-14726

Streamline getting started experience

Attach filesAttach ScreenshotAdd voteVotersWatch issueWatchersCreate sub-taskLinkCloneUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

Details

    • Task
    • Status: Open
    • Major
    • Resolution: Unresolved
    • None
    • None
    • None

    Description

      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:

      1. 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!
      2. First step of the tutorial should be to enable security (basic auth should suffice).
      3. ./bin/solr start e cloud <- All references of -e should be removed.
      4. All references of bin/solr post to be replaced with curl
      5. Convert all bin/solr create references to curl of collection creation commands
      6. Add docker based startup instructions.
      7. 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
      8. 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.
      9. Use V2 APIs everywhere in the tutorial
      10. Remove all example modes, sample data (films, tech products etc.), configsets from Solr's distribution (instead let the examples refer to them from github)
      11. Remove the post tool from Solr, curl should suffice.

      Attachments

        Activity

          This comment will be Viewable by All Users Viewable by All Users
          Cancel

          People

            ichattopadhyaya Ishan Chattopadhyaya
            ichattopadhyaya Ishan Chattopadhyaya

            Dates

              Created:
              Updated:

              Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0h
                0h
                Logged:
                Time Spent - 2h
                2h

                Slack

                  Issue deployment