[ 
https://issues.apache.org/jira/browse/SOLR-10842?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16058307#comment-16058307
 ] 

Cassandra Targett commented on SOLR-10842:
------------------------------------------

This is where I'm heading with this:

Solr Quick Start (the Tutorial)
* Start Solr
* Create Collection
* Index basic data 
* Stop Solr/Restart
* Deeper Look (other sections)
* Where to go next

Solr Installation and Upgrades (rename "Getting Started" section; following are 
sub-sections)
* Installation
** System requirements (including Java)
** Unix/Windows requirements for using bin/solr
** Untar/unzip package

* Orientation to your Solr Install
** Where stuff is - what's in the various directories
** Exampledocs & how to use them
** Major config files

* Taking Solr to Production (move here)

* Upgrading Solr (move here)

> 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

Reply via email to