[
https://issues.apache.org/jira/browse/SOLR-10842?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16058125#comment-16058125
]
Cassandra Targett commented on SOLR-10842:
------------------------------------------
I'm working through how to reorganize Solr's entire "Getting Started" content.
I think it's really fair to say it's "poor" today. Here's a breakdown of what
we do today in that section:
Getting Started
* Solr is awesome!
* Sections in this section
Installation
* Java requirements
* Untar the package (doesn't use package name "solr-x.y.z.tar.gz")
Running Solr
* Start Solr (and stop)
* Create a core
* Basic indexing
A Quick Overview
* Schema concepts
* Solr is amazing!
A Step Closer
* Install directories
* Major config files
Solr Control Script Reference
* Start/Stop
* Create/Remove Collection
* Auth
* ZK
A fair bit of duplicated concepts, low on actual facts, page titles don't
reflect what is actually covered there, etc. I'm still working through how I
might replace it, but one thing is I want the pages to be clear and give users
a really solid orientation to the system.
> 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: master (7.0)
>
>
> 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: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
