Mailing-List: contact dev-help@lucene.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@lucene.apache.org
Date: Fri, 23 Jun 2017 19:13:00 +0000 (UTC)
From: "Cassandra Targett (JIRA)" <jira@apache.org>
To: dev@lucene.apache.org
Message-ID: <JIRA.13078060.1496858064000.94758.1498245180082@Atlassian.JIRA>
In-Reply-To: <JIRA.13078060.1496858064000@Atlassian.JIRA>
References: <JIRA.13078060.1496858064000@Atlassian.JIRA> <JIRA.13078060.1496858064452@jira-lw-us.apache.org>
Subject: [jira] [Updated] (SOLR-10842) Move quickstart.html to Ref Guide
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
archived-at: Fri, 23 Jun 2017 19:13:05 -0000


     [ https://issues.apache.org/jira/browse/SOLR-10842?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Cassandra Targett updated SOLR-10842:
-------------------------------------
    Attachment: SOLR-10842.patch

Here is a WIP patch for the changes I'm looking at so far if anyone is curious. It moves a lot of stuff around and there is still a lot TODO yet.

This patch:

* Adds the Solr Tutorial as {{solr-quick-start.adoc}} and as a top-level section, directly under "About this Guide" in the page hierarchy.
* Reorganizes the sections under "Getting Started":
** Removes {{a-step-closer.adoc}} from that hierarchy (but it is not entirely removed yet)
** Moves "Taking Solr to Production", "Upgrading a Solr Cluster", and "Upgrading Solr" to the Getting Started section (the first 2 were under "Managing Solr", the last was a top-level section)
** Moves pages in this section around a little bit
* Adds two new pages:
** {{solr-system-requirements.adoc}} as an overview of Solr's installation requirements
** {{solr-configuration-files.adoc}} as an overview of Solr Home and relevant Solr config files
* Removes some redundant content that appeared on several pages
* Moves {{solr-control-script-reference.adoc}} to become a top-level section that comes after "Getting Started" in the page hierarchy.

Known TODOs (not including some minor notes in the files already):
* Remove {{a-step-closer.adoc}} entirely
* Consider renaming "Getting Started" to <something-I-haven't-decided yet>
** Finalize the page depending on its name
* Flesh out system requirements information
* Rename "Upgrading Solr" to "Solr Upgrade Notes" or something similar to indicate it's not "how to upgrade Solr"
* Fix the Solr Tutorial
** It's broken already today because of javadoc changes in SOLR-10862
** Possibly break it up a bit into smaller bits depending on amount of time user has

I may also add more to the TODO list as I continue to work through the pages.

> 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)
>
>         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: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org