[
https://issues.apache.org/jira/browse/SOLR-10842?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16111680#comment-16111680
]
Cassandra Targett commented on SOLR-10842:
------------------------------------------
I've made a lot of new changes, and to make review easier all around, I pushed
the branch I've been working on to {{jira/solr-10842}}.
I redesigned the tutorial (and renamed it from "Quick Start" to "Tutorial") so
it now follows a 3-exercise plan that takes the user through some steps and
educates him/her along the way about a few things:
* Exercise 1 shows how to use {{bin/solr}} to launch Solr in cloud mode, index
some data and do some queries. It takes the user through the full interactive
session so the {{sample_techproducts_configs}} can be used, explaining each
step along the way. The user then indexes the techproducts data with
{{bin/post}} and runs a few types of searches (simple keyword, fielded search,
phrase search).
* Exercise 2 shows how to create another collection, index the films sample
data, and work with facets. The collection in this exercise uses the
{{_default}} configset. It explains the limitations of schemaless, and exposes
them to using the Schema API to manually create a field and a copyField so the
films data is properly indexed. Then the user works with facets - simple
facets, date range facets, then pivot facets.
* Exercise 3 isn't much of an exercise, really, but an encouragement for the
user to index a local set of data, taking into consideration any schema needs,
etc. It points to using {{bin/post}} for "rich" files like PDFs, Word, etc., or
DIH, or SolrJ, or the Documents Screen in the UI. It asks the user to start
thinking about their needs for implementation.
This is probably mostly there, but the Windows coverage is relatively spotty.
Some actions have Windows corollary commands, but most don't. I forget how to
use Windows entirely, so would appreciate some assistance there. There may also
be typos, etc., that need to be fixed. Since it's on a branch, submissions are
welcome.
Still TODO are to rename the "Upgrading Solr Page" as I mentioned in earlier
comments, and possibly rename "Getting Started".
This is holding me up from a couple other things needed for 7.0 Ref Guide (like
upgrading info), so I hope to commit these changes as soon as I finish those
items and do a couple more read-throughs (by the end of the week maybe?).
> Move quickstart.html to Ref Guide
> ---------------------------------
>
> Key: SOLR-10842
> URL: https://issues.apache.org/jira/browse/SOLR-10842
> Project: Solr
> Issue Type: Improvement
> Security Level: Public(Default Security Level. Issues are Public)
> Components: documentation
> Reporter: Cassandra Targett
> Assignee: Cassandra Targett
> Priority: Minor
> Fix For: 7.0
>
> Attachments: SOLR-10842.patch
>
>
> The Solr Quick Start at https://lucene.apache.org/solr/quickstart.html has
> been problematic to keep up to date - until Ishan just updated it yesterday
> for 6.6, it said "6.2.1", so hadn't been updated for several releases.
> Now that the Ref Guide is in AsciiDoc format, we can easily use variables for
> package versions, and it could be released as part of the Ref Guide and kept
> up to date. It could also integrate links to more information on topics, and
> users would already be IN the docs, so they would not need to wonder where
> the docs are.
> There are a few places on the site that will need to be updated to point to
> the new location, but I can also put a redirect rule into .htaccess so people
> are redirected to the new location if there are other links "in the wild"
> that we cannot control. This allows it to be versioned also, if that becomes
> necessary.
> As part of this, I would like to also update the entire "Getting Started"
> section of the Ref Guide, which is effectively identical to what was in the
> first release of the Ref Guide back in 2009 for Solr 1.4 and is in serious
> need of reconsideration.
> My thought is that moving the page + redoing the Getting Started section
> would be for 7.0, but if folks are excited about this idea I could move the
> page for 6.6 and hold off redoing the larger section until 7.0.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
