You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ho...@apache.org on 2017/05/09 21:05:18 UTC
[1/3] lucene-solr:jira/solr-10290: SOLR-10640: change the html page
layout to include an id with teh page shortname (just like the pdf
effectively does) and remove the HACK in CheckLinksAndAnchors that faked this
Repository: lucene-solr
Updated Branches:
refs/heads/jira/solr-10290 96058f824 -> 296c2f48e
SOLR-10640: change the html page layout to include an id with teh page shortname (just like the pdf effectively does) and remove the HACK in CheckLinksAndAnchors that faked this
only one page had a dup anchor that needed fixed as a result
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/add32b39
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/add32b39
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/add32b39
Branch: refs/heads/jira/solr-10290
Commit: add32b39ff051330c99f1ec8bc04cc3c4144a061
Parents: 96058f8
Author: Chris Hostetter <ho...@apache.org>
Authored: Tue May 9 13:47:28 2017 -0700
Committer: Chris Hostetter <ho...@apache.org>
Committed: Tue May 9 13:47:28 2017 -0700
----------------------------------------------------------------------
solr/solr-ref-guide/src/_layouts/page.html | 2 +-
solr/solr-ref-guide/src/installing-solr.adoc | 1 +
.../tools/CheckLinksAndAnchors.java | 25 ++++----------------
3 files changed, 6 insertions(+), 22 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/add32b39/solr/solr-ref-guide/src/_layouts/page.html
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/_layouts/page.html b/solr/solr-ref-guide/src/_layouts/page.html
index 8c8f94e..5818cdb 100755
--- a/solr/solr-ref-guide/src/_layouts/page.html
+++ b/solr/solr-ref-guide/src/_layouts/page.html
@@ -38,7 +38,7 @@ layout: default
{% include toc.html %}
{% endunless %}
-<div id="main-content">
+<div id="{{ page.shortname }}" class="main-content">
{{content}}
</div>
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/add32b39/solr/solr-ref-guide/src/installing-solr.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/installing-solr.adoc b/solr/solr-ref-guide/src/installing-solr.adoc
index 44a7993..e38a2d6 100644
--- a/solr/solr-ref-guide/src/installing-solr.adoc
+++ b/solr/solr-ref-guide/src/installing-solr.adoc
@@ -20,6 +20,7 @@ Java HotSpot(TM) 64-Bit Server VM (build 25.60-b23, mixed mode)
The exact output will vary, but you need to make sure you meet the minimum version requirement. We also recommend choosing a version that is not end-of-life from its vendor. If you don't have the required version, or if the java command is not found, download and install the latest version from Oracle at http://www.oracle.com/technetwork/java/javase/downloads/index.html.
+[[install-command]]
== Installing Solr
Solr is available from the Solr website at http://lucene.apache.org/solr/.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/add32b39/solr/solr-ref-guide/tools/CheckLinksAndAnchors.java
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/tools/CheckLinksAndAnchors.java b/solr/solr-ref-guide/tools/CheckLinksAndAnchors.java
index 9d9daeb..6bdf218 100644
--- a/solr/solr-ref-guide/tools/CheckLinksAndAnchors.java
+++ b/solr/solr-ref-guide/tools/CheckLinksAndAnchors.java
@@ -42,6 +42,8 @@ import org.jsoup.select.NodeVisitor;
* files/anchors actaully exist.
* </p>
*
+ * TODO: build a list of all known external links so that some other tool could (optionally) ping them all for 200 status?
+ *
* @see https://github.com/asciidoctor/asciidoctor/issues/1865
* @see https://github.com/asciidoctor/asciidoctor/issues/1866
*/
@@ -81,7 +83,7 @@ public class CheckLinksAndAnchors {
final String fileContents = readFile(file.getPath());
final Document doc = Jsoup.parse(fileContents);
- final Element mainContent = doc.select("#main-content").first();
+ final Element mainContent = doc.select(".main-content").first();
if (mainContent == null) {
throw new RuntimeException(file.getName() + " has no main-content div");
}
@@ -94,7 +96,7 @@ public class CheckLinksAndAnchors {
assert 0 != id.length();
// special case ids that we ignore
- if (id.equals("preamble") || id.equals("main-content")) {
+ if (id.equals("preamble")) {
continue;
}
@@ -106,25 +108,6 @@ public class CheckLinksAndAnchors {
idsToFiles.get(id).add(file);
}
- {
- // special case: implicitly assume each file contains an id matching it's filename
- // since that's the convention used in linking - for the HTML links these ID's don't
- // exist but we don't care since #frags pointed at non-existend IDs are ignored br browsers.
- // in the PDF these *will* exist and we need to ensure there won't be any dups / misdirected links
- // in that case.
- final String id = file.getName().substring(0, file.getName().lastIndexOf("."));
- if (0 == mainContent.select("[id=\""+id+"\"]").size()) {
- if (idsToFiles.containsKey(id)) {
- idsInMultiFiles.add(id);
- } else {
- idsToFiles.put(id, new ArrayList<File>(1));
- }
- idsToFiles.get(id).add(file);
- }
- }
-
-
-
// check for (relative) links that don't include a fragment
final Elements links = mainContent.select("a[href]");
for (Element link : links) {
[2/3] lucene-solr:jira/solr-10290: Fixup last remaining
TODOs/questions regarding cwiki URLs and hardcoded TOCs
Posted by ho...@apache.org.
Fixup last remaining TODOs/questions regarding cwiki URLs and hardcoded TOCs
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/320aedd6
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/320aedd6
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/320aedd6
Branch: refs/heads/jira/solr-10290
Commit: 320aedd60aafb406dd83110cf3a43f906af7e361
Parents: add32b3
Author: Chris Hostetter <ho...@apache.org>
Authored: Tue May 9 14:02:01 2017 -0700
Committer: Chris Hostetter <ho...@apache.org>
Committed: Tue May 9 14:02:01 2017 -0700
----------------------------------------------------------------------
.../src/the-well-configured-solr-instance.adoc | 2 --
...-the-solr-administration-user-interface.adoc | 28 ++++++++------------
2 files changed, 11 insertions(+), 19 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/320aedd6/solr/solr-ref-guide/src/the-well-configured-solr-instance.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/the-well-configured-solr-instance.adoc b/solr/solr-ref-guide/src/the-well-configured-solr-instance.adoc
index 4408811..d89019a 100644
--- a/solr/solr-ref-guide/src/the-well-configured-solr-instance.adoc
+++ b/solr/solr-ref-guide/src/the-well-configured-solr-instance.adoc
@@ -5,8 +5,6 @@
This section tells you how to fine-tune your Solr instance for optimum performance.
-// TODO: this page is basically a large TOC - do we want to keep it or reword it?
-
This section covers the following topics:
<<configuring-solrconfig-xml.adoc#configuring-solrconfig-xml,Configuring solrconfig.xml>>: Describes how to work with the main configuration file for Solr, `solrconfig.xml`, covering the major sections of the file.
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/320aedd6/solr/solr-ref-guide/src/using-the-solr-administration-user-interface.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/using-the-solr-administration-user-interface.adoc b/solr/solr-ref-guide/src/using-the-solr-administration-user-interface.adoc
index 7442a69..9a458b1 100644
--- a/solr/solr-ref-guide/src/using-the-solr-administration-user-interface.adoc
+++ b/solr/solr-ref-guide/src/using-the-solr-administration-user-interface.adoc
@@ -5,12 +5,6 @@
This section discusses the Solr Administration User Interface ("Admin UI").
-// TODO: areThis page is nothing but a giant TOC ... we keeping this page?
-// TODO: should we just slurp overview-of-the-solr-admin-ui.adoc in here?
-// TODO: can we programatically build this from the data files?
-
-// TODO: if we do keep this page, all the cwiki links need replaced with relative paths to the new pages
-
The <<overview-of-the-solr-admin-ui.adoc#overview-of-the-solr-admin-ui,Overview of the Solr Admin UI>> explains the basic features of the user interface, what's on the initial Admin UI page, and how to configure the interface. In addition, there are pages describing each screen of the Admin UI:
@@ -22,15 +16,15 @@ The <<overview-of-the-solr-admin-ui.adoc#overview-of-the-solr-admin-ui,Overview
* *<<thread-dump.adoc#thread-dump,Thread Dump>>* lets you see detailed information about each thread, along with state information.
* *<<collection-specific-tools.adoc#collection-specific-tools,Collection-Specific Tools>>* is a section explaining additional screens available for each collection.
-** https://cwiki.apache.org/confluence/display/solr/Analysis+Screen[Analysis] - lets you analyze the data found in specific fields.
-** https://cwiki.apache.org/confluence/display/solr/Dataimport+Screen[Dataimport] - shows you information about the current status of the Data Import Handler.
-** https://cwiki.apache.org/confluence/display/solr/Documents+Screen[Documents] - provides a simple form allowing you to execute various Solr indexing commands directly from the browser.
-** https://cwiki.apache.org/confluence/display/solr/Files+Screen[Files] - shows the current core configuration files such as `solrconfig.xml`.
-** https://cwiki.apache.org/confluence/display/solr/Query+Screen[Query] - lets you submit a structured query about various elements of a core.
-** https://cwiki.apache.org/confluence/display/solr/Stream+Screen[Stream] - allows you to submit streaming expressions and see results and parsing explanations.
-** https://cwiki.apache.org/confluence/display/solr/Schema+Browser+Screen[Schema Browser] - displays schema data in a browser window.
+** <<analysis-screen.adoc#analysis-screen,Analysis>> - lets you analyze the data found in specific fields.
+** <<dataimport-screen.adoc#dataimport-screen,Dataimport>> - shows you information about the current status of the Data Import Handler.
+** <<documents-screen.adoc#documents-screen,Documents>> - provides a simple form allowing you to execute various Solr indexing commands directly from the browser.
+** <<files-screen.adoc#files-screen,Files>> - shows the current core configuration files such as `solrconfig.xml`.
+** <<query-screen.adoc#query-screen,Query>> - lets you submit a structured query about various elements of a core.
+** <<stream-screen.adoc#stream-screen,Stream>> - allows you to submit streaming expressions and see results and parsing explanations.
+** <<schema-browser-screen.adoc#schema-browser-screen,Schema Browser>> - displays schema data in a browser window.
* *<<core-specific-tools.adoc#core-specific-tools,Core-Specific Tools>>* is a section explaining additional screens available for each named core.
-** https://cwiki.apache.org/confluence/display/solr/Ping[Ping] - lets you ping a named core and determine whether the core is active.
-** https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=32604180[Plugins/Stats] - shows statistics for plugins and other installed components.
-** https://cwiki.apache.org/confluence/display/solr/Replication+Screen[Replication] - shows you the current replication status for the core, and lets you enable/disable replication.
-** https://cwiki.apache.org/confluence/display/solr/Segments+Info[Segments Info] - Provides a visualization of the underlying Lucene index segments.
+** <<ping.adoc#ping,Ping>> - lets you ping a named core and determine whether the core is active.
+** <<plugins-stats-screen#plugins-stats-screen,Plugins/Stats>> - shows statistics for plugins and other installed components.
+** <<replication-screen.adoc#replication-screen,Replication>> - shows you the current replication status for the core, and lets you enable/disable replication.
+** <<segments-info.adoc#segments-info,Segments Info>> - Provides a visualization of the underlying Lucene index segments.
[3/3] lucene-solr:jira/solr-10290: use versioned link for online
errata
Posted by ho...@apache.org.
use versioned link for online errata
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/296c2f48
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/296c2f48
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/296c2f48
Branch: refs/heads/jira/solr-10290
Commit: 296c2f48eba6a92466659a06b96f7dacb4d05ffd
Parents: 320aedd
Author: Chris Hostetter <ho...@apache.org>
Authored: Tue May 9 14:04:59 2017 -0700
Committer: Chris Hostetter <ho...@apache.org>
Committed: Tue May 9 14:04:59 2017 -0700
----------------------------------------------------------------------
solr/solr-ref-guide/src/errata.adoc | 11 +----------
1 file changed, 1 insertion(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/296c2f48/solr/solr-ref-guide/src/errata.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/errata.adoc b/solr/solr-ref-guide/src/errata.adoc
index b3390fe..4608992 100644
--- a/solr/solr-ref-guide/src/errata.adoc
+++ b/solr/solr-ref-guide/src/errata.adoc
@@ -7,16 +7,7 @@
Any mistakes found in this documentation after its release will be listed on the on-line version of this page:
-//TODO we need to update this URL or make a decision about this page...
-// since we'll have the ability to regen the "hosted" HTML version of the guide,
-// after release, we can always use the verion variable to generate the Errata URL
-// specific to this "version" of the guide...
-// https://lucene.apache.org/solr/guide/{solr-docs-version}/errata.html
-// ...and/or a URL to the "latest" nightly build of the guide...
-// https://lucene.apache.org/solr/guide/nightly-draft/errata.html
-// (assuming some URL RewriteRule that maps /solr/guide/nightly/.* to our jenkins build)
-//
-http://s.apache.org/errata[http://s.apache.org/errata]
+https://lucene.apache.org/solr/guide/{solr-docs-version}/errata.html
[[Errata-ErrataForPastVersionsofThisDocumentation]]
== Errata For Past Versions of This Documentation