Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-8713

New UI points to the wiki for Query Syntax instead of the Reference Guide

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: Trivial
    • Resolution: Fixed
    • Affects Version/s: 6.0
    • Fix Version/s: 6.0
    • Component/s: Admin UI
    • Labels:

      Issue Links

        Activity

        Hide
        mariusneo Marius Grama added a comment -

        With the changes from SOLR-7858 the welcome-file is not anymore admin.html, but instead index.html .
        index.html contains an older link for the solr query syntax.

        Show
        mariusneo Marius Grama added a comment - With the changes from SOLR-7858 the welcome-file is not anymore admin.html, but instead index.html . index.html contains an older link for the solr query syntax.
        Hide
        githubbot ASF GitHub Bot added a comment -

        GitHub user mariusneo opened a pull request:

        https://github.com/apache/lucene-solr/pull/12

        SOLR-8713 Update wiki-query-syntax link to point towards : https://cw

        Update wiki-query-syntax link to point towards https://cwiki.apache.org/confluence/display/solr/Query+Syntax+and+Parsing

        Along the way I've updated the links that existed in some other solrconfig.xml files.

        You can merge this pull request into a Git repository by running:

        $ git pull https://github.com/mariusneo/lucene-solr bugfix/SOLR-8713

        Alternatively you can review and apply these changes as the patch at:

        https://github.com/apache/lucene-solr/pull/12.patch

        To close this pull request, make a commit to your master/trunk branch
        with (at least) the following in the commit message:

        This closes #12


        commit e86fa97d5830887d73a275ad3a95e69ac79c6c20
        Author: Marius <mariusneo@gmail.com>
        Date: 2016-02-26T19:15:14Z

        SOLR-8713 Update wiki-query-syntax link to point towards : https://cwiki.apache.org/confluence/display/solr/Query+Syntax+and+Parsing


        Show
        githubbot ASF GitHub Bot added a comment - GitHub user mariusneo opened a pull request: https://github.com/apache/lucene-solr/pull/12 SOLR-8713 Update wiki-query-syntax link to point towards : https://cw … Update wiki-query-syntax link to point towards https://cwiki.apache.org/confluence/display/solr/Query+Syntax+and+Parsing Along the way I've updated the links that existed in some other solrconfig.xml files. You can merge this pull request into a Git repository by running: $ git pull https://github.com/mariusneo/lucene-solr bugfix/ SOLR-8713 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/lucene-solr/pull/12.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #12 commit e86fa97d5830887d73a275ad3a95e69ac79c6c20 Author: Marius <mariusneo@gmail.com> Date: 2016-02-26T19:15:14Z SOLR-8713 Update wiki-query-syntax link to point towards : https://cwiki.apache.org/confluence/display/solr/Query+Syntax+and+Parsing
        Hide
        githubbot ASF GitHub Bot added a comment -

        GitHub user mariusneo opened a pull request:

        https://github.com/apache/lucene-solr/pull/14

        SOLR-8713 Update wiki-query-syntax link

        Update wiki-query-syntax link to point towards : https://cwiki.apache.org/confluence/display/solr/Query+Syntax+and+Parsing

        Along the way I've updated the Solr query syntax link also within several solrconfig.xml files.

        You can merge this pull request into a Git repository by running:

        $ git pull https://github.com/mariusneo/lucene-solr bugfix/SOLR-8713

        Alternatively you can review and apply these changes as the patch at:

        https://github.com/apache/lucene-solr/pull/14.patch

        To close this pull request, make a commit to your master/trunk branch
        with (at least) the following in the commit message:

        This closes #14


        commit 9f5e4768a772b4375c5979dd61a440504bfdceb0
        Author: Marius <mariusneo@gmail.com>
        Date: 2016-02-26T19:15:14Z

        SOLR-8713 Update wiki-query-syntax link to point towards : https://cwiki.apache.org/confluence/display/solr/Query+Syntax+and+Parsing


        Show
        githubbot ASF GitHub Bot added a comment - GitHub user mariusneo opened a pull request: https://github.com/apache/lucene-solr/pull/14 SOLR-8713 Update wiki-query-syntax link Update wiki-query-syntax link to point towards : https://cwiki.apache.org/confluence/display/solr/Query+Syntax+and+Parsing Along the way I've updated the Solr query syntax link also within several solrconfig.xml files. You can merge this pull request into a Git repository by running: $ git pull https://github.com/mariusneo/lucene-solr bugfix/ SOLR-8713 Alternatively you can review and apply these changes as the patch at: https://github.com/apache/lucene-solr/pull/14.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #14 commit 9f5e4768a772b4375c5979dd61a440504bfdceb0 Author: Marius <mariusneo@gmail.com> Date: 2016-02-26T19:15:14Z SOLR-8713 Update wiki-query-syntax link to point towards : https://cwiki.apache.org/confluence/display/solr/Query+Syntax+and+Parsing
        Hide
        jkrupan Jack Krupansky added a comment -

        Be careful, because Confluence has the working text of the NEXT release of Solr (6.0 right now), not the current release or even necessarily the release that the admin UI is running.

        It would be nice if the Confluence doc was per-release in addition to the development version, but right now only the PDF is per-release, which is what the admin UI should point to.

        Show
        jkrupan Jack Krupansky added a comment - Be careful, because Confluence has the working text of the NEXT release of Solr (6.0 right now), not the current release or even necessarily the release that the admin UI is running. It would be nice if the Confluence doc was per-release in addition to the development version, but right now only the PDF is per-release, which is what the admin UI should point to.
        Hide
        tomasflobbe Tomás Fernández Löbbe added a comment -

        That's true, but the same thing happens with the wiki (yes, sometimes we put things like "Only since 4.0" there, but anyway). I think pointing to the right page in Confluence is good enough, specially since that's what we are currently doing in the deprecated UI. I wouldn't like pointing to the PDF

        Show
        tomasflobbe Tomás Fernández Löbbe added a comment - That's true, but the same thing happens with the wiki (yes, sometimes we put things like "Only since 4.0" there, but anyway). I think pointing to the right page in Confluence is good enough, specially since that's what we are currently doing in the deprecated UI. I wouldn't like pointing to the PDF
        Hide
        mariusneo Marius Grama added a comment -

        Jack Krupansky thank you for the feedback.
        I agree with what you are saying that the wiki page may be misleading pointing towards the NEXT version of Solr (6.0 now), but I see the link "5.5 Ref Guide (PDF Download)" referenced in the wiki page. Also the solr ref guide PDF provides not only query syntax help, but is the full reference guide for Solr. In case that the link would point towards this PDF, the name of the link would need to be changed to "Solr Reference Guide".
        Nevertheless, the current link http://wiki.apache.org/solr/SolrQuerySyntax points towards Solr 4.x wiki. The solr query syntax link was until recently pointing towards to the https://cwiki.apache.org/confluence/display/solr/Query+Syntax+and+Parsing (from admin.html ) webpage. IMO the link should still point to the confluence query link.

        It would be nice if the Confluence doc was per-release in addition to the development version

        I guess the reason why there is only the one (latest) version of the document present in the wiki, is to avoid the duplication of maintenance.

        Show
        mariusneo Marius Grama added a comment - Jack Krupansky thank you for the feedback. I agree with what you are saying that the wiki page may be misleading pointing towards the NEXT version of Solr (6.0 now), but I see the link "5.5 Ref Guide (PDF Download)" referenced in the wiki page. Also the solr ref guide PDF provides not only query syntax help, but is the full reference guide for Solr. In case that the link would point towards this PDF, the name of the link would need to be changed to "Solr Reference Guide". Nevertheless, the current link http://wiki.apache.org/solr/SolrQuerySyntax points towards Solr 4.x wiki. The solr query syntax link was until recently pointing towards to the https://cwiki.apache.org/confluence/display/solr/Query+Syntax+and+Parsing (from admin.html ) webpage. IMO the link should still point to the confluence query link. It would be nice if the Confluence doc was per-release in addition to the development version I guess the reason why there is only the one (latest) version of the document present in the wiki, is to avoid the duplication of maintenance.
        Hide
        elyograg Shawn Heisey added a comment -

        points towards Solr 4.x wiki

        The moinmoin wiki is not for 4.x. A lot of the content has gotten out of date, but other parts of it are updated regularly and have fully current information.

        That older wiki needs an overhaul. Some of the information needs to be removed because the information in the reference guide is better and completely supersedes what's there now, but there is still some value in having duplicate information for certain topics, because the wiki version can be presented differently, in a format that's better for quick lookups than the reference guide, which is intended to be full documentation. A good example of this is the following page:

        https://wiki.apache.org/solr/AnalyzersTokenizersTokenFilters

        I use this page all the time, because it's easily searchable for a particular analysis component and has quick-n-dirty examples. I don't recall seeing anything in the reference guide like that page.

        Show
        elyograg Shawn Heisey added a comment - points towards Solr 4.x wiki The moinmoin wiki is not for 4.x. A lot of the content has gotten out of date, but other parts of it are updated regularly and have fully current information. That older wiki needs an overhaul. Some of the information needs to be removed because the information in the reference guide is better and completely supersedes what's there now, but there is still some value in having duplicate information for certain topics, because the wiki version can be presented differently, in a format that's better for quick lookups than the reference guide, which is intended to be full documentation. A good example of this is the following page: https://wiki.apache.org/solr/AnalyzersTokenizersTokenFilters I use this page all the time, because it's easily searchable for a particular analysis component and has quick-n-dirty examples. I don't recall seeing anything in the reference guide like that page.
        Hide
        tomasflobbe Tomás Fernández Löbbe added a comment -

        I do believe that having a documentation snapshot per release (other than the pdf) would be better for linking in the code/UI, but not having that, I think the ref guide is the best place right now. Most parts of the wiki are outdated or not being maintained, plus the old UI is linking to the ref guide, I don't believe the new UI switched back to the wiki intentionally.
        If nobody is against this change in particular I'll commit it, PR looks good to me.

        Show
        tomasflobbe Tomás Fernández Löbbe added a comment - I do believe that having a documentation snapshot per release (other than the pdf) would be better for linking in the code/UI, but not having that, I think the ref guide is the best place right now. Most parts of the wiki are outdated or not being maintained, plus the old UI is linking to the ref guide, I don't believe the new UI switched back to the wiki intentionally. If nobody is against this change in particular I'll commit it, PR looks good to me.
        Hide
        upayavira Upayavira added a comment -

        It would be great to have online, per release snapshots of the wiki, but in lieu of that, this patch looks good to me.

        Show
        upayavira Upayavira added a comment - It would be great to have online, per release snapshots of the wiki, but in lieu of that, this patch looks good to me.
        Hide
        tomasflobbe Tomás Fernández Löbbe added a comment -

        Again, not sure why the commit didn't make it to Jira, same as SOLR-8671, not sure what I'm doing wrong...

        commit 20b7453cc8a5f5ad14fb2d2637eb7a31f72d62f7
        Author: Tomás Fernández Löbbe <tflobbe@apache.org>
        Date:   Mon Feb 29 08:22:25 2016 -0800
        
            SOLR-8713: new UI and example solrconfig files point to Reference Guide for Solr Query Syntax instead of the wiki.
            
            This closes #12
        

        Thanks Marius! And thanks for all the comments/reviews.

        Show
        tomasflobbe Tomás Fernández Löbbe added a comment - Again, not sure why the commit didn't make it to Jira, same as SOLR-8671 , not sure what I'm doing wrong... commit 20b7453cc8a5f5ad14fb2d2637eb7a31f72d62f7 Author: Tomás Fernández Löbbe <tflobbe@apache.org> Date: Mon Feb 29 08:22:25 2016 -0800 SOLR-8713: new UI and example solrconfig files point to Reference Guide for Solr Query Syntax instead of the wiki. This closes #12 Thanks Marius! And thanks for all the comments/reviews.
        Hide
        mariusneo Marius Grama added a comment - - edited

        Tomás Fernández Löbbe shouldn't this commit land also on origin/branch_5_5 ? I see it on origin/master now, which means that it will be available only on version 6.0 of solr.
        Also the pull request https://github.com/apache/lucene-solr/pull/14 is still open.

        Show
        mariusneo Marius Grama added a comment - - edited Tomás Fernández Löbbe shouldn't this commit land also on origin/branch_5_5 ? I see it on origin/master now, which means that it will be available only on version 6.0 of solr. Also the pull request https://github.com/apache/lucene-solr/pull/14 is still open.
        Hide
        tomasflobbe Tomás Fernández Löbbe added a comment -

        I was being lazy and not backporting. 6.0 will be out soon, and this Angular UI is not default in 5.x, so the impact is even smaller.
        We don't need PRs for multiple branches, I can just cherrypick the commit from master to the branch if needed, would you mind close it yourself since I didn't mention it in the commit message?

        Show
        tomasflobbe Tomás Fernández Löbbe added a comment - I was being lazy and not backporting. 6.0 will be out soon, and this Angular UI is not default in 5.x, so the impact is even smaller. We don't need PRs for multiple branches, I can just cherrypick the commit from master to the branch if needed, would you mind close it yourself since I didn't mention it in the commit message?

          People

          • Assignee:
            tomasflobbe Tomás Fernández Löbbe
            Reporter:
            tomasflobbe Tomás Fernández Löbbe
          • Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development