You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Hoss Man (JIRA)" <ji...@apache.org> on 2014/09/15 18:42:33 UTC
[jira] [Commented] (SOLR-6520) Documentation web page is missing
link to live Solr Reference Guide
[ https://issues.apache.org/jira/browse/SOLR-6520?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14134098#comment-14134098 ]
Hoss Man commented on SOLR-6520:
--------------------------------
bq. The official document page for Solr is missing the link to the live Solr Reference Guide.
this is intentional - the live guide refers to unreleased content, and we want to minimize confusion (we already occasionally get people posting comments on pages saying "that's not how it works in the current version of solr" when the docs have been updated to reflect the soon-to-be-released version.
bq. It is also not linked from the release-specific documentation page either.
Nor should it be? ... if someone is looking at a historical link to something like "https://lucene.apache.org/solr/4_5_0/index.html" because that's the version of solr they are running it would be a really bad idea of that linked them to the _current_ live copy of the ref guide that had all sorts of info about features/syntax that don't exist in their version.
figuring out a good way to link to the ref guide download link for those pages would certainly be a good idea though - specially since those pages are in the solr release itself. but the problem is the ref guide is frequently not available for a week or so after the official release (due to final editing). so the best ew can probably do is a generic link to the main documentation page. (https://lucene.apache.org/solr/documentation.html)
bq. This means the search engines do not easily discover the new content and it does not show up in searches for when people look for information. It also means people may hesitate to look at it, if they have to download the whole PDF first.
both valid concerns we should try to address... but i'm not sure how best to deal with them in a way that doesn't confuse/misslead users.
> Documentation web page is missing link to live Solr Reference Guide
> -------------------------------------------------------------------
>
> Key: SOLR-6520
> URL: https://issues.apache.org/jira/browse/SOLR-6520
> Project: Solr
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 4.10
> Environment: web
> Reporter: Alexandre Rafalovitch
> Priority: Minor
> Labels: documentation, website
>
> The [official document page for Solr|https://lucene.apache.org/solr/documentation.html] is missing the link to the live Solr Reference Guide. Only the link to PDF is there. In fact, one has to go to the WIKI, it seems to find the link.
> It is also not linked from [the release-specific documentation page|https://lucene.apache.org/solr/4_10_0/index.html] either.
> This means the search engines do not easily discover the new content and it does not show up in searches for when people look for information. It also means people may hesitate to look at it, if they have to download the whole PDF first.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org