lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Hoss Man (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (SOLR-10297) Resolve Ref Guide build errors
Date Tue, 09 May 2017 23:03:04 GMT

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

Hoss Man commented on SOLR-10297:
---------------------------------

It looks like we could resolve these errors just by adding a {{==}} header to {{index.adoc}}
and {{further-assistance.adoc}} ala the patch below ... but i'm not sure if the cure is better
then the disease?

{noformat}
diff --git a/solr/solr-ref-guide/src/further-assistance.adoc b/solr/solr-ref-guide/src/further-assistance.adoc
index 8cbeedc..373a317 100644
--- a/solr/solr-ref-guide/src/further-assistance.adoc
+++ b/solr/solr-ref-guide/src/further-assistance.adoc
@@ -2,6 +2,8 @@
 :page-shortname: further-assistance
 :page-permalink: further-assistance.html
 
+== Seeking Futher Assistance
+
 There is a very active user community around Solr and Lucene. The solr-user mailing list,
and #solr IRC channel are both great resources for asking questions.
 
 To view the mailing list archives, subscribe to the list, or join the IRC channel, please
see https://lucene.apache.org/solr/community.html.
diff --git a/solr/solr-ref-guide/src/index.adoc b/solr/solr-ref-guide/src/index.adoc
index d1f0a84..d1b8e2a 100644
--- a/solr/solr-ref-guide/src/index.adoc
+++ b/solr/solr-ref-guide/src/index.adoc
@@ -5,6 +5,8 @@
 
 This reference guide describes Apache Solr, the open source solution for search. You can
download Apache Solr from the Solr website at http://lucene.apache.org/solr/.
 
+== Welcome to the Reference Guide for Apache Solr {solr-docs-version}
+
 This Guide contains the following sections:
 
 *<<getting-started.adoc#getting-started,Getting Started>>*: This section guides
you through the installation and setup of Solr.
{noformat}

> Resolve Ref Guide build errors
> ------------------------------
>
>                 Key: SOLR-10297
>                 URL: https://issues.apache.org/jira/browse/SOLR-10297
>             Project: Solr
>          Issue Type: Sub-task
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: documentation
>            Reporter: Cassandra Targett
>         Attachments: build-errors-HTML-20170315.txt, build-errors-PDF-20170315.txt
>
>
> The asciidoctor tools used to build the HTML and PDF versions of the Ref Guide validate
the pages during the build and throw errors during the build when there are problems. Usually
these problems are not fatal, but they do indicate inconsistencies in the content that should
be resolved. Almost all of the time they are problems with inconsistent heading levels - a
h5 follows a h2 for example.
> These errors should be cleaned up so we only see errors we should worry about going forward.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


Mime
View raw message