Solr
  1. Solr
  2. SOLR-4730

Place link to Solr wiki in a more prominent place

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 4.3, 6.0
    • Component/s: documentation
    • Labels:

      Description

      Solr homepage (http://lucene.apache.org/solr/4_2_1/) lists reference docs and javadocs, but makes it very easy to skip the link to the Wiki. From a new user's perspective, the wiki is probably the most important, so please make it more prominent.

      1. SOLR-4730.patch
        1 kB
        Uri Laserson

        Activity

        Hide
        Robert Muir added a comment -

        Nice idea:

        maybe instead of:

        This is the official documentation for Apache Solr 4.2.1. Additional documentation is available in the Wiki.
        
        Reference Documents
        
            Changes: List of changes in this release.
        

        something like:

        This is the official documentation for Apache Solr 4.2.1
        Reference Documents
        
            Solr wiki: <some description that makes sense>
            Changes: List of changes in this release.
        
        Show
        Robert Muir added a comment - Nice idea: maybe instead of: This is the official documentation for Apache Solr 4.2.1. Additional documentation is available in the Wiki. Reference Documents Changes: List of changes in this release. something like: This is the official documentation for Apache Solr 4.2.1 Reference Documents Solr wiki: <some description that makes sense> Changes: List of changes in this release.
        Hide
        Robert Muir added a comment -

        By the way, this page is generated automatically from http://svn.apache.org/repos/asf/lucene/dev/trunk/solr/site/xsl/index.xsl in our regular source tree (solr/site/xsl/index.xsl in your checkout)

        Uri, want to contribute a patch to improve this thing?

        See http://wiki.apache.org/lucene-java/HowToContribute

        Show
        Robert Muir added a comment - By the way, this page is generated automatically from http://svn.apache.org/repos/asf/lucene/dev/trunk/solr/site/xsl/index.xsl in our regular source tree (solr/site/xsl/index.xsl in your checkout) Uri, want to contribute a patch to improve this thing? See http://wiki.apache.org/lucene-java/HowToContribute
        Hide
        Uri Laserson added a comment -

        Sure...one sec...

        Show
        Uri Laserson added a comment - Sure...one sec...
        Hide
        Uri Laserson added a comment -

        Is the lucene-solr github repo the same thing as the svn repo referenced in the HowToContribute page?

        Show
        Uri Laserson added a comment - Is the lucene-solr github repo the same thing as the svn repo referenced in the HowToContribute page?
        Hide
        Robert Muir added a comment -

        after you modify the file, you can run 'ant documentation' from solr/, and then look in solr/build/docs/index.html in your browser to see the generated file.

        Show
        Robert Muir added a comment - after you modify the file, you can run 'ant documentation' from solr/, and then look in solr/build/docs/index.html in your browser to see the generated file.
        Hide
        Robert Muir added a comment -

        yeah, lucene-solr github repo is essentially the same.

        I have some rough instructions for using that here: http://wiki.apache.org/lucene-java/HowToContributeFastPath

        Show
        Robert Muir added a comment - yeah, lucene-solr github repo is essentially the same. I have some rough instructions for using that here: http://wiki.apache.org/lucene-java/HowToContributeFastPath
        Hide
        Uri Laserson added a comment -

        Patch is attached.

        The github instructions should be integrated with the other HowTo page.

        Also, couldn't build the docs:

        Buildfile: /Users/laserson/repos/lucene-solr/build.xml

        documentation:

        BUILD FAILED
        /Users/laserson/repos/lucene-solr/build.xml:53: The following error occurred while executing this line:
        /Users/laserson/repos/lucene-solr/lucene/build.xml:23: The following error occurred while executing this line:
        /Users/laserson/repos/lucene-solr/lucene/common-build.xml:287: Minimum supported Java version is 1.7.

        Show
        Uri Laserson added a comment - Patch is attached. The github instructions should be integrated with the other HowTo page. Also, couldn't build the docs: Buildfile: /Users/laserson/repos/lucene-solr/build.xml documentation: BUILD FAILED /Users/laserson/repos/lucene-solr/build.xml:53: The following error occurred while executing this line: /Users/laserson/repos/lucene-solr/lucene/build.xml:23: The following error occurred while executing this line: /Users/laserson/repos/lucene-solr/lucene/common-build.xml:287: Minimum supported Java version is 1.7.
        Hide
        Uwe Schindler added a comment -

        Lucene trunk which will be Lucene 5.0 needs Java 7.

        Show
        Uwe Schindler added a comment - Lucene trunk which will be Lucene 5.0 needs Java 7.
        Hide
        Robert Muir added a comment -

        Thanks Uri, nice improvement for the release.

        About integrating the git instructions: its just something I hacked together but I didn't know the best way to integrate into the regular contributor instructions.

        I also don't like that these instructions are duplicated across both the lucene and solr wikis when its only one development project.

        I sent an email with this to the developer list, because I think its vital for these instructions to be as simple as possible, but unfortunately there wasn't much interest (http://search-lucene.com/m/sxPSK1hg8BH/refactoring+howtocontribute&subj=refactoring+HowToContribute)

        In any case, if you are interested/have ideas, see http://wiki.apache.org/solr/#How_to_edit_this_Wiki

        If you sign up and get a user name, just ping back and we can give you write access to the wiki.

        Show
        Robert Muir added a comment - Thanks Uri, nice improvement for the release. About integrating the git instructions: its just something I hacked together but I didn't know the best way to integrate into the regular contributor instructions. I also don't like that these instructions are duplicated across both the lucene and solr wikis when its only one development project. I sent an email with this to the developer list, because I think its vital for these instructions to be as simple as possible, but unfortunately there wasn't much interest ( http://search-lucene.com/m/sxPSK1hg8BH/refactoring+howtocontribute&subj=refactoring+HowToContribute ) In any case, if you are interested/have ideas, see http://wiki.apache.org/solr/#How_to_edit_this_Wiki If you sign up and get a user name, just ping back and we can give you write access to the wiki.
        Hide
        Uwe Schindler added a comment -

        Closed after release.

        Show
        Uwe Schindler added a comment - Closed after release.

          People

          • Assignee:
            Unassigned
            Reporter:
            Uri Laserson
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development