SOLR-10842: Convert all remaining {{quickstart.html}} links to {{guide/solr-tutorial.html}}; remove all references to quickstart from the build; and version the link to the ref guide's tutorial in Solr's versioned top-level documentation page.

This commit is contained in:
Steve Rowe 2017-10-04 14:47:11 -04:00
parent 5c62fb56f7
commit 93d8e428ea
8 changed files with 20 additions and 33 deletions

View File

@ -210,9 +210,6 @@ def checkAll(dirName):
elif link.find('lucene.apache.org/solr/mirrors-solr-latest-redir.html') != -1: elif link.find('lucene.apache.org/solr/mirrors-solr-latest-redir.html') != -1:
# OK # OK
pass pass
elif link.find('lucene.apache.org/solr/quickstart.html') != -1:
# OK
pass
elif link.find('lucene.apache.org/solr/guide/') != -1: elif link.find('lucene.apache.org/solr/guide/') != -1:
# OK # OK
pass pass

View File

@ -14,7 +14,7 @@ Getting Started
You need a Java 1.8 VM or later installed. You need a Java 1.8 VM or later installed.
In this release, there is an example Solr server including a bundled In this release, there is an example Solr server including a bundled
servlet container in the directory named "example". servlet container in the directory named "example".
See the Quick Start guide at http://lucene.apache.org/solr/quickstart.html See the Solr tutorial at https://lucene.apache.org/solr/guide/solr-tutorial.html
================== 8.0.0 ================== ================== 8.0.0 ==================

View File

@ -87,8 +87,8 @@ For more information about Solr examples please read...
* example/README.txt * example/README.txt
For more information about the "Solr Home" and Solr specific configuration For more information about the "Solr Home" and Solr specific configuration
* http://lucene.apache.org/solr/quickstart.html * https://lucene.apache.org/solr/guide/solr-tutorial.html
For a Quick Start guide For a Solr tutorial
* http://lucene.apache.org/solr/resources.html * http://lucene.apache.org/solr/resources.html
For a list of other tutorials and introductory articles. For a list of other tutorials and introductory articles.

View File

@ -191,22 +191,6 @@
depends="javadocs,changes-to-html,process-webpages"/> depends="javadocs,changes-to-html,process-webpages"/>
<target name="compile-core" depends="compile-solr-core" unless="solr.core.compiled"/> <target name="compile-core" depends="compile-solr-core" unless="solr.core.compiled"/>
<target name="generate-website-quickstart"
description="Generate a version of the quickstart tutorial suitable for the website, at build/website/quickstart.mdtext">
<copy file="${common-solr.dir}/site/quickstart.mdtext" tofile="${common-solr.dir}/build/website/quickstart.mdtext"
overwrite="false" encoding="UTF-8">
<filterchain>
<tokenfilter>
<filetokenizer/>
<!-- Website images are under /solr/assets/images/ -->
<replaceregex pattern="src\s*=\s*&quot;images/" replace="src=&quot;/solr/assets/images/" flags="gs"/>
<!-- Redirect to the website's version-specific system requirements page -->
<replaceregex pattern="\(SYSTEM_REQUIREMENTS.html\)" replace="(/solr/api/SYSTEM_REQUIREMENTS.html)" flags="gs"/>
</tokenfilter>
</filterchain>
</copy>
</target>
<target name="documentation-online" description="Generate a link to the online documentation" <target name="documentation-online" description="Generate a link to the online documentation"
depends="define-solr-javadoc-url"> depends="define-solr-javadoc-url">
<xslt in="${ant.file}" out="${javadoc-online.dir}/index.html" style="site/online-link.xsl" force="true"> <xslt in="${ant.file}" out="${javadoc-online.dir}/index.html" style="site/online-link.xsl" force="true">
@ -226,6 +210,16 @@
<makeurl property="process-webpages.buildfiles" separator="|"> <makeurl property="process-webpages.buildfiles" separator="|">
<fileset dir="." includes="core/build.xml,test-framework/build.xml,solrj/build.xml,contrib/**/build.xml"/> <fileset dir="." includes="core/build.xml,test-framework/build.xml,solrj/build.xml,contrib/**/build.xml"/>
</makeurl> </makeurl>
<loadresource property="doc-solr-guide-version-path">
<propertyresource name="version"/>
<filterchain>
<tokenfilter>
<filetokenizer/>
<replaceregex pattern="^(\d+)\.(\d+).*" replace="\1_\2"/>
</tokenfilter>
</filterchain>
</loadresource>
<!-- <!--
The XSL input file is ignored completely, but XSL expects one to be given, The XSL input file is ignored completely, but XSL expects one to be given,
so we pass ourself (${ant.file}) here. The list of module build.xmls is given so we pass ourself (${ant.file}) here. The list of module build.xmls is given
@ -239,6 +233,7 @@
<param name="buildfiles" expression="${process-webpages.buildfiles}"/> <param name="buildfiles" expression="${process-webpages.buildfiles}"/>
<param name="version" expression="${version}"/> <param name="version" expression="${version}"/>
<param name="luceneJavadocUrl" expression="${lucene.javadoc.url}"/> <param name="luceneJavadocUrl" expression="${lucene.javadoc.url}"/>
<param name="solrGuideVersion" expression="${doc-solr-guide-version-path}"/>
</xslt> </xslt>
<markdown todir="${javadoc.dir}"> <markdown todir="${javadoc.dir}">
@ -676,7 +671,7 @@
<!-- NOTE: must currently exclude deprecated-list due to a javadocs bug (as of 1.7.0_09) <!-- NOTE: must currently exclude deprecated-list due to a javadocs bug (as of 1.7.0_09)
javadocs generates invalid XML if you deprecate a method that takes a parameter javadocs generates invalid XML if you deprecate a method that takes a parameter
with a generic type --> with a generic type -->
<fileset dir="build/docs" includes="**/*.html" excludes="**/deprecated-list.html,quickstart.html"/> <fileset dir="build/docs" includes="**/*.html" excludes="**/deprecated-list.html"/>
</jtidy-macro> </jtidy-macro>
<echo message="Checking for broken links..."/> <echo message="Checking for broken links..."/>
<check-broken-links dir="${javadoc.dir}"/> <check-broken-links dir="${javadoc.dir}"/>

View File

@ -14,7 +14,7 @@ For information on how to get started with solr ltr please see:
For information on how to get started with solr please see: For information on how to get started with solr please see:
* [solr/README.txt](../../README.txt) * [solr/README.txt](../../README.txt)
* [Solr Quick Start](http://lucene.apache.org/solr/quickstart.html) * [Solr Tutorial](https://lucene.apache.org/solr/guide/solr-tutorial.html)
# How To Contribute # How To Contribute

View File

@ -48,8 +48,8 @@ For more information about this example please read...
* example/solr/README.txt * example/solr/README.txt
For more information about the "Solr Home" and Solr specific configuration For more information about the "Solr Home" and Solr specific configuration
* http://lucene.apache.org/solr/quickstart.html * https://lucene.apache.org/solr/guide/solr-tutorial.html
For a Tutorial using this example configuration For a Solr tutorial
* http://wiki.apache.org/solr/SolrResources * http://wiki.apache.org/solr/SolrResources
For a list of other tutorials and introductory articles. For a list of other tutorials and introductory articles.

View File

@ -23,6 +23,7 @@
<xsl:param name="buildfiles"/> <xsl:param name="buildfiles"/>
<xsl:param name="version"/> <xsl:param name="version"/>
<xsl:param name="luceneJavadocUrl"/> <xsl:param name="luceneJavadocUrl"/>
<xsl:param name="solrGuideVersion"/>
<!-- <!--
NOTE: This template matches the root element of any given input XML document! NOTE: This template matches the root element of any given input XML document!
@ -74,7 +75,7 @@
<li><a href="http://wiki.apache.org/solr">Wiki</a>: Additional documentation, especially focused on using Solr.</li> <li><a href="http://wiki.apache.org/solr">Wiki</a>: Additional documentation, especially focused on using Solr.</li>
<li><a href="changes/Changes.html">Changes</a>: List of changes in this release.</li> <li><a href="changes/Changes.html">Changes</a>: List of changes in this release.</li>
<li><a href="SYSTEM_REQUIREMENTS.html">System Requirements</a>: Minimum and supported Java versions.</li> <li><a href="SYSTEM_REQUIREMENTS.html">System Requirements</a>: Minimum and supported Java versions.</li>
<li><a href="quickstart.html">Solr Quick Start</a>: This document covers the basics of running Solr using an example schema, and some sample data.</li> <li><a href="https://lucene.apache.org/solr/guide/{$solrGuideVersion}/solr-tutorial.html">Solr Tutorial</a>: This document covers the basics of running Solr using an example schema, and some sample data.</li>
<li><a href="{$luceneJavadocUrl}index.html">Lucene Documentation</a></li> <li><a href="{$luceneJavadocUrl}index.html">Lucene Documentation</a></li>
</ul> </ul>
<h2>API Javadocs</h2> <h2>API Javadocs</h2>

View File

@ -1,6 +0,0 @@
<!-- As of 2 Oct 2017, this page now automatically redirects to
the Solr Reference Guide page solr/guide/solr-tutorial.html -->
# Solr Quick Start
Please see the [Solr Tutorial](https://lucene.apache.org/solr/guide/solr-tutorial.html) or additional [Resources](http://lucene.apache.org/solr/resources.html).