You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by sa...@apache.org on 2017/10/04 19:25:48 UTC
[1/2] lucene-solr:master: 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
docu
Repository: lucene-solr
Updated Branches:
refs/heads/branch_7x 8ac381a6a -> 916599386
refs/heads/master 5c62fb56f -> 93d8e428e
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.
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/93d8e428
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/93d8e428
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/93d8e428
Branch: refs/heads/master
Commit: 93d8e428ea4643c6641d8a9b2c73827683b831a4
Parents: 5c62fb5
Author: Steve Rowe <sa...@apache.org>
Authored: Wed Oct 4 14:47:11 2017 -0400
Committer: Steve Rowe <sa...@apache.org>
Committed: Wed Oct 4 15:25:20 2017 -0400
----------------------------------------------------------------------
dev-tools/scripts/checkJavadocLinks.py | 3 ---
solr/CHANGES.txt | 2 +-
solr/README.txt | 4 ++--
solr/build.xml | 29 ++++++++++++-----------------
solr/contrib/ltr/README.md | 2 +-
solr/example/README.txt | 4 ++--
solr/site/index.xsl | 3 ++-
solr/site/quickstart.mdtext | 6 ------
8 files changed, 20 insertions(+), 33 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/93d8e428/dev-tools/scripts/checkJavadocLinks.py
----------------------------------------------------------------------
diff --git a/dev-tools/scripts/checkJavadocLinks.py b/dev-tools/scripts/checkJavadocLinks.py
index d3ba89a..8ae0f4c 100644
--- a/dev-tools/scripts/checkJavadocLinks.py
+++ b/dev-tools/scripts/checkJavadocLinks.py
@@ -210,9 +210,6 @@ def checkAll(dirName):
elif link.find('lucene.apache.org/solr/mirrors-solr-latest-redir.html') != -1:
# OK
pass
- elif link.find('lucene.apache.org/solr/quickstart.html') != -1:
- # OK
- pass
elif link.find('lucene.apache.org/solr/guide/') != -1:
# OK
pass
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/93d8e428/solr/CHANGES.txt
----------------------------------------------------------------------
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
index 928d37f..4996a13 100644
--- a/solr/CHANGES.txt
+++ b/solr/CHANGES.txt
@@ -14,7 +14,7 @@ Getting Started
You need a Java 1.8 VM or later installed.
In this release, there is an example Solr server including a bundled
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 ==================
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/93d8e428/solr/README.txt
----------------------------------------------------------------------
diff --git a/solr/README.txt b/solr/README.txt
index 6af0cc6..0de8b57 100644
--- a/solr/README.txt
+++ b/solr/README.txt
@@ -87,8 +87,8 @@ For more information about Solr examples please read...
* example/README.txt
For more information about the "Solr Home" and Solr specific configuration
- * http://lucene.apache.org/solr/quickstart.html
- For a Quick Start guide
+ * https://lucene.apache.org/solr/guide/solr-tutorial.html
+ For a Solr tutorial
* http://lucene.apache.org/solr/resources.html
For a list of other tutorials and introductory articles.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/93d8e428/solr/build.xml
----------------------------------------------------------------------
diff --git a/solr/build.xml b/solr/build.xml
index 16d4201..9b0bdab 100644
--- a/solr/build.xml
+++ b/solr/build.xml
@@ -191,22 +191,6 @@
depends="javadocs,changes-to-html,process-webpages"/>
<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*"images/" replace="src="/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"
depends="define-solr-javadoc-url">
<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="|">
<fileset dir="." includes="core/build.xml,test-framework/build.xml,solrj/build.xml,contrib/**/build.xml"/>
</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,
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="version" expression="${version}"/>
<param name="luceneJavadocUrl" expression="${lucene.javadoc.url}"/>
+ <param name="solrGuideVersion" expression="${doc-solr-guide-version-path}"/>
</xslt>
<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)
javadocs generates invalid XML if you deprecate a method that takes a parameter
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>
<echo message="Checking for broken links..."/>
<check-broken-links dir="${javadoc.dir}"/>
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/93d8e428/solr/contrib/ltr/README.md
----------------------------------------------------------------------
diff --git a/solr/contrib/ltr/README.md b/solr/contrib/ltr/README.md
index 6b56cdf..6324ecf 100644
--- a/solr/contrib/ltr/README.md
+++ b/solr/contrib/ltr/README.md
@@ -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:
* [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
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/93d8e428/solr/example/README.txt
----------------------------------------------------------------------
diff --git a/solr/example/README.txt b/solr/example/README.txt
index 4c8cca1..562c256 100644
--- a/solr/example/README.txt
+++ b/solr/example/README.txt
@@ -48,8 +48,8 @@ For more information about this example please read...
* example/solr/README.txt
For more information about the "Solr Home" and Solr specific configuration
- * http://lucene.apache.org/solr/quickstart.html
- For a Tutorial using this example configuration
+ * https://lucene.apache.org/solr/guide/solr-tutorial.html
+ For a Solr tutorial
* http://wiki.apache.org/solr/SolrResources
For a list of other tutorials and introductory articles.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/93d8e428/solr/site/index.xsl
----------------------------------------------------------------------
diff --git a/solr/site/index.xsl b/solr/site/index.xsl
index b75fb9c..20eeea7 100644
--- a/solr/site/index.xsl
+++ b/solr/site/index.xsl
@@ -23,6 +23,7 @@
<xsl:param name="buildfiles"/>
<xsl:param name="version"/>
<xsl:param name="luceneJavadocUrl"/>
+ <xsl:param name="solrGuideVersion"/>
<!--
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="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="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>
</ul>
<h2>API Javadocs</h2>
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/93d8e428/solr/site/quickstart.mdtext
----------------------------------------------------------------------
diff --git a/solr/site/quickstart.mdtext b/solr/site/quickstart.mdtext
deleted file mode 100644
index 92f593d..0000000
--- a/solr/site/quickstart.mdtext
+++ /dev/null
@@ -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).
[2/2] lucene-solr:branch_7x: 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
d
Posted by sa...@apache.org.
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.
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/91659938
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/91659938
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/91659938
Branch: refs/heads/branch_7x
Commit: 91659938610036034d0bf1abc7786d781c4f661c
Parents: 8ac381a
Author: Steve Rowe <sa...@apache.org>
Authored: Wed Oct 4 14:47:11 2017 -0400
Committer: Steve Rowe <sa...@apache.org>
Committed: Wed Oct 4 15:25:35 2017 -0400
----------------------------------------------------------------------
dev-tools/scripts/checkJavadocLinks.py | 3 ---
solr/CHANGES.txt | 2 +-
solr/README.txt | 4 ++--
solr/build.xml | 29 ++++++++++++-----------------
solr/contrib/ltr/README.md | 2 +-
solr/example/README.txt | 4 ++--
solr/site/index.xsl | 3 ++-
solr/site/quickstart.mdtext | 6 ------
8 files changed, 20 insertions(+), 33 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/91659938/dev-tools/scripts/checkJavadocLinks.py
----------------------------------------------------------------------
diff --git a/dev-tools/scripts/checkJavadocLinks.py b/dev-tools/scripts/checkJavadocLinks.py
index d3ba89a..8ae0f4c 100644
--- a/dev-tools/scripts/checkJavadocLinks.py
+++ b/dev-tools/scripts/checkJavadocLinks.py
@@ -210,9 +210,6 @@ def checkAll(dirName):
elif link.find('lucene.apache.org/solr/mirrors-solr-latest-redir.html') != -1:
# OK
pass
- elif link.find('lucene.apache.org/solr/quickstart.html') != -1:
- # OK
- pass
elif link.find('lucene.apache.org/solr/guide/') != -1:
# OK
pass
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/91659938/solr/CHANGES.txt
----------------------------------------------------------------------
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
index 222906a..3761f36 100644
--- a/solr/CHANGES.txt
+++ b/solr/CHANGES.txt
@@ -14,7 +14,7 @@ Getting Started
You need a Java 1.8 VM or later installed.
In this release, there is an example Solr server including a bundled
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
================== 7.1.0 ==================
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/91659938/solr/README.txt
----------------------------------------------------------------------
diff --git a/solr/README.txt b/solr/README.txt
index 6af0cc6..0de8b57 100644
--- a/solr/README.txt
+++ b/solr/README.txt
@@ -87,8 +87,8 @@ For more information about Solr examples please read...
* example/README.txt
For more information about the "Solr Home" and Solr specific configuration
- * http://lucene.apache.org/solr/quickstart.html
- For a Quick Start guide
+ * https://lucene.apache.org/solr/guide/solr-tutorial.html
+ For a Solr tutorial
* http://lucene.apache.org/solr/resources.html
For a list of other tutorials and introductory articles.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/91659938/solr/build.xml
----------------------------------------------------------------------
diff --git a/solr/build.xml b/solr/build.xml
index 16d4201..9b0bdab 100644
--- a/solr/build.xml
+++ b/solr/build.xml
@@ -191,22 +191,6 @@
depends="javadocs,changes-to-html,process-webpages"/>
<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*"images/" replace="src="/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"
depends="define-solr-javadoc-url">
<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="|">
<fileset dir="." includes="core/build.xml,test-framework/build.xml,solrj/build.xml,contrib/**/build.xml"/>
</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,
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="version" expression="${version}"/>
<param name="luceneJavadocUrl" expression="${lucene.javadoc.url}"/>
+ <param name="solrGuideVersion" expression="${doc-solr-guide-version-path}"/>
</xslt>
<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)
javadocs generates invalid XML if you deprecate a method that takes a parameter
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>
<echo message="Checking for broken links..."/>
<check-broken-links dir="${javadoc.dir}"/>
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/91659938/solr/contrib/ltr/README.md
----------------------------------------------------------------------
diff --git a/solr/contrib/ltr/README.md b/solr/contrib/ltr/README.md
index 6b56cdf..6324ecf 100644
--- a/solr/contrib/ltr/README.md
+++ b/solr/contrib/ltr/README.md
@@ -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:
* [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
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/91659938/solr/example/README.txt
----------------------------------------------------------------------
diff --git a/solr/example/README.txt b/solr/example/README.txt
index 4c8cca1..562c256 100644
--- a/solr/example/README.txt
+++ b/solr/example/README.txt
@@ -48,8 +48,8 @@ For more information about this example please read...
* example/solr/README.txt
For more information about the "Solr Home" and Solr specific configuration
- * http://lucene.apache.org/solr/quickstart.html
- For a Tutorial using this example configuration
+ * https://lucene.apache.org/solr/guide/solr-tutorial.html
+ For a Solr tutorial
* http://wiki.apache.org/solr/SolrResources
For a list of other tutorials and introductory articles.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/91659938/solr/site/index.xsl
----------------------------------------------------------------------
diff --git a/solr/site/index.xsl b/solr/site/index.xsl
index b75fb9c..20eeea7 100644
--- a/solr/site/index.xsl
+++ b/solr/site/index.xsl
@@ -23,6 +23,7 @@
<xsl:param name="buildfiles"/>
<xsl:param name="version"/>
<xsl:param name="luceneJavadocUrl"/>
+ <xsl:param name="solrGuideVersion"/>
<!--
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="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="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>
</ul>
<h2>API Javadocs</h2>
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/91659938/solr/site/quickstart.mdtext
----------------------------------------------------------------------
diff --git a/solr/site/quickstart.mdtext b/solr/site/quickstart.mdtext
deleted file mode 100644
index 92f593d..0000000
--- a/solr/site/quickstart.mdtext
+++ /dev/null
@@ -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).