[
https://issues.apache.org/jira/browse/SOLR-10842?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16091619#comment-16091619
]
Cassandra Targett commented on SOLR-10842:
------------------------------------------
bq. Please consider whether the just committed SOLR-9526 affects the Quickstart
guide in any way.
It does, but in a mostly minor way. The much bigger problem is that the primary
indexing example that most of the later query examples depend on is no longer
possible (SOLR-10862). That has a much deeper impact throughout.
I likely need some help figuring out how to replace that example. I tried to
replace it with a simple web crawl using post.jar, but it's not working. I also
think that's problematic - users may think post.jar is a crawler, which would
be incorrect, and if they don't have internet access they're stuck. The other
exampledocs are relatively light - it's a possibility, but would be nice to
have something more robust.
There is a nice set of example docs in {{example/films}}, but the README there
says the user should explicitly set up a few fields in the schema before
indexing them, which is also not ideal for the very first step of a "quick
start". The changes in SOLR-9526 may in fact help that - I'll try it and see if
that can be used instead without any manual field manipulation by users.
> 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]
