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

Cassandra Targett commented on SOLR-11875:
------------------------------------------

The obstacle here is the need to change the version dynamically, which is the 
same problem discussed in SOLR-11143, but in that case we were talking only 
about the v2 API spec files.

That issue stemmed from SOLR-10848, where I added new Ref Guide links to the 
specs without defining a version at all (they will always redirect to the 
latest version). We sort of really had to then, though, the old Ref Guide was 
broken and a redirect to the new location wasn't in place yet.

The links changed with the patch are really generic - they all go to the parent 
page of a larger section that has child pages for the various sections of a 
solrconfig.xml file. There is little about the page we're pointing them at that 
will change release-to-release. It's the info they get after that point that 
could be incorrect for them.

It's for sure wrong to point users at the wrong version, but it's also wrong to 
continue to point them at a Solr Wiki page that hasn't really been updated 
since 2013 (except for 2 tiny edits in 2016). Which is worse? If we can't solve 
SOLR-11143 yet, then wouldn't it be better to at least get users to a place 
where they might be able to find the docs for their version?

> merge SolrConfigXml wiki into Solr Reference Guide
> --------------------------------------------------
>
>                 Key: SOLR-11875
>                 URL: https://issues.apache.org/jira/browse/SOLR-11875
>             Project: Solr
>          Issue Type: Task
>          Components: documentation, website
>            Reporter: Christine Poerschke
>            Priority: Minor
>         Attachments: SOLR-11875.patch
>
>
> The default and example solrconfig.xml currently point to the 
> https://wiki.apache.org/solr/SolrConfigXml page, might we change that perhaps 
> to point into the Solr Reference Guide (and merge content from the wiki into 
> the ref guide where appropriate)?
> {code}
> <!--
>       For more details about configurations options that may appear in
> -     this file, see http://wiki.apache.org/solr/SolrConfigXml.
> +     this file, see 
> https://lucene.apache.org/solr/guide/7_x/configuring-solrconfig-xml.html.
> -->
> {code}
> Implementation detail: the {{7_x}} in the above would need to be an actual 
> {{7_3}} etc. version in each release.
>  



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to