Details

    • Type: Sub-task
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 6.5, 7.0
    • Component/s: Build
    • Labels:
      None

      Description

      Spinoff from SOLR-6806. This sub task will replace the contents of docs in the binary download with a link to the online JavaDocs. The build should make sure to generate a link to the correct version. I believe this is the correct tamplate: http://lucene.apache.org/solr/6_2_0/

      1. SOLR-9450.patch
        9 kB
        Uwe Schindler
      2. SOLR-9450.patch
        9 kB
        Uwe Schindler
      3. SOLR-9450.patch
        8 kB
        Jan Høydahl
      4. SOLR-9450.patch
        8 kB
        Jan Høydahl
      5. SOLR-9450.patch
        8 kB
        Jan Høydahl
      6. SOLR-9450.patch
        7 kB
        Jan Høydahl

        Issue Links

          Activity

          Hide
          janhoy Jan Høydahl added a comment -

          Attaching patch.
          This patch defines a new build target documentation-online which gets called only for create-package. It builds a single index.html file in docs/, which contains a link to online docs folder:

          Follow this link to view online documentation for Solr x.y.z
          

          In case of local SNAPSHOT build, the text in that HTML file is instead:

          No online documentation available for SNAPSHOT versions. Run ant documentation to build docs locally.
          
          Show
          janhoy Jan Høydahl added a comment - Attaching patch. This patch defines a new build target documentation-online which gets called only for create-package . It builds a single index.html file in docs/ , which contains a link to online docs folder: Follow this link to view online documentation for Solr x.y.z In case of local SNAPSHOT build, the text in that HTML file is instead: No online documentation available for SNAPSHOT versions. Run ant documentation to build docs locally.
          Hide
          janhoy Jan Høydahl added a comment -

          I don't think we need to provide a downloadable archive with the docs. Instead we can tell people to download the source distro and run ant documentation locally, no?

          The solr-7.0.0 tgz artefact size is 148979967 before the patch and 143403689 after, thus saving (only) 5,3Mb.
          On my laptop, build time for binary distro was reduced from 7 minutes 28 seconds to 4 minutes 58 seconds

          Show
          janhoy Jan Høydahl added a comment - I don't think we need to provide a downloadable archive with the docs. Instead we can tell people to download the source distro and run ant documentation locally, no? The solr-7.0.0 tgz artefact size is 148979967 before the patch and 143403689 after, thus saving (only) 5,3Mb. On my laptop, build time for binary distro was reduced from 7 minutes 28 seconds to 4 minutes 58 seconds
          Hide
          thetaphi Uwe Schindler added a comment -

          In general, this looks good, but might need some imrpovements:

          • On Jenkins the nightly builds (Solr-Artifacts) have a real version number (with datecode), so the generated link in the Groovy code might be wrong. Like for the lucene.javadoc.url the Jenkins jobs need to be changed to define $solr.javadoc.url in the ant properties to show something useful. It already does this for Solr jobs, to refer to Lucene links correctly.
          • It would be good to also refer to lucene.javadoc.url
          • It does not build the documentation of the package at all, but if you have them in checkout before, you may need to ant clean. This is not documented. Maybe build the "online only" documentation in a separate folder. This would also allow Jenkins task to publish them online, too
          • The release manager now needs to build the docs separately, because of this I suggest to really build the online-only version in a separate folder (see prvious item). This allows to publish the Javadocs after building artifacts, although they are not part of the tarball.
          Show
          thetaphi Uwe Schindler added a comment - In general, this looks good, but might need some imrpovements: On Jenkins the nightly builds (Solr-Artifacts) have a real version number (with datecode), so the generated link in the Groovy code might be wrong. Like for the lucene.javadoc.url the Jenkins jobs need to be changed to define $solr.javadoc.url in the ant properties to show something useful. It already does this for Solr jobs, to refer to Lucene links correctly. It would be good to also refer to lucene.javadoc.url It does not build the documentation of the package at all, but if you have them in checkout before, you may need to ant clean. This is not documented. Maybe build the "online only" documentation in a separate folder. This would also allow Jenkins task to publish them online, too The release manager now needs to build the docs separately, because of this I suggest to really build the online-only version in a separate folder (see prvious item). This allows to publish the Javadocs after building artifacts, although they are not part of the tarball.
          Hide
          thetaphi Uwe Schindler added a comment -

          On my laptop, build time for binary distro was reduced from 7 minutes 28 seconds to 4 minutes 58 seconds

          That does not help the release manager, because he now has to build Solr two times, otherwise he can't publish the docs.

          Show
          thetaphi Uwe Schindler added a comment - On my laptop, build time for binary distro was reduced from 7 minutes 28 seconds to 4 minutes 58 seconds That does not help the release manager, because he now has to build Solr two times, otherwise he can't publish the docs.
          Hide
          janhoy Jan Høydahl added a comment -

          It would be good to also refer to lucene.javadoc.url

          Do you mean to add a clickable link to the Lucene docs, or to use lucene.javadoc.url as source for generating solr.javadoc.url?

          The release manager now needs to build the docs separately, because of this I suggest to really build the online-only version in a separate folder

          Will do... New patch coming up

          Show
          janhoy Jan Høydahl added a comment - It would be good to also refer to lucene.javadoc.url Do you mean to add a clickable link to the Lucene docs, or to use lucene.javadoc.url as source for generating solr.javadoc.url? The release manager now needs to build the docs separately, because of this I suggest to really build the online-only version in a separate folder Will do... New patch coming up
          Hide
          janhoy Jan Høydahl added a comment -

          I have a version of the patch which instead depends on lucene.javadoc.url and simply replaces /core/ => /solr/. That avoids modifying Jenkins jobs, and keeps the patch slightly smaller. Do you see any downsides to this approach?

          Show
          janhoy Jan Høydahl added a comment - I have a version of the patch which instead depends on lucene.javadoc.url and simply replaces /core/ => /solr/. That avoids modifying Jenkins jobs, and keeps the patch slightly smaller. Do you see any downsides to this approach?
          Hide
          janhoy Jan Høydahl added a comment -

          Attaching new patch:

          • We now build the online version of docs in ${javadoc-online.dir}. which is build/docs-online, to avoid overwriting the full javadocs
          • The create-package target only depends on documentation-online, while package now also depends on documentation target, to make sure that build/docs is also generated in that case.
          • Reuses property lucene.javadoc.url, so no need to instrument Jenkins for solr.javadoc.url
          Show
          janhoy Jan Høydahl added a comment - Attaching new patch: We now build the online version of docs in ${javadoc-online.dir}. which is build/docs-online , to avoid overwriting the full javadocs The create-package target only depends on documentation-online , while package now also depends on documentation target, to make sure that build/docs is also generated in that case. Reuses property lucene.javadoc.url , so no need to instrument Jenkins for solr.javadoc.url
          Hide
          janhoy Jan Høydahl added a comment -

          Uwe Schindler, Do you think the latest patch is acceptable?

          We'd also need to update the website and documentation, such as quickstart.mdtext which currently suggests indexing the docs/ folder

          Show
          janhoy Jan Høydahl added a comment - Uwe Schindler , Do you think the latest patch is acceptable? We'd also need to update the website and documentation, such as quickstart.mdtext which currently suggests indexing the docs/ folder
          Hide
          thetaphi Uwe Schindler added a comment -

          This wont fully help for Jenkins, because Jenkins does not have /core/ or /solr/. The Jenkins Jobs pass a completely arbitrary URL to the Jobs as property. So the explicit property for SOLR and Lucene makes more sense (no search/replace, please).

          On Jenkins we need to make sure to build the full javadocs, too (I think they are in the new folder and just packaged in a different way) and then pass the Build-URL/javadocs through Ant properties.

          Show
          thetaphi Uwe Schindler added a comment - This wont fully help for Jenkins, because Jenkins does not have /core/ or /solr/. The Jenkins Jobs pass a completely arbitrary URL to the Jobs as property. So the explicit property for SOLR and Lucene makes more sense (no search/replace, please). On Jenkins we need to make sure to build the full javadocs, too (I think they are in the new folder and just packaged in a different way) and then pass the Build-URL/javadocs through Ant properties.
          Hide
          thetaphi Uwe Schindler added a comment -

          See my comment about the properties above, otherwise fine.

          Show
          thetaphi Uwe Schindler added a comment - See my comment about the properties above, otherwise fine.
          Hide
          janhoy Jan Høydahl added a comment -

          Ok, attaching patch with separate solr.javadoc.url property.

          When generating index.html in online-link.xsl we check for the text "SNAPSHOT" in $version and if not present we generate a link to whatever URL is in the property.

          Was this how you imagined it, Uwe?

          Show
          janhoy Jan Høydahl added a comment - Ok, attaching patch with separate solr.javadoc.url property. When generating index.html in online-link.xsl we check for the text "SNAPSHOT" in $version and if not present we generate a link to whatever URL is in the property. Was this how you imagined it, Uwe?
          Hide
          janhoy Jan Høydahl added a comment -

          Are we still positive to this change? I could push it for 6.5
          One benefit of not distributing javadocs with the binary release is that Windows users won't have to wait a year for Unzip to complete

          Show
          janhoy Jan Høydahl added a comment - Are we still positive to this change? I could push it for 6.5 One benefit of not distributing javadocs with the binary release is that Windows users won't have to wait a year for Unzip to complete
          Hide
          arafalov Alexandre Rafalovitch added a comment -

          I could not apply it to the master.

          $ git apply --check ~/Downloads/SOLR-9450.patch
          error: patch failed: solr/CHANGES.txt:154
          error: solr/CHANGES.txt: patch does not apply
          error: patch failed: solr/build.xml:187
          error: solr/build.xml: patch does not apply

          Show
          arafalov Alexandre Rafalovitch added a comment - I could not apply it to the master. $ git apply --check ~/Downloads/ SOLR-9450 .patch error: patch failed: solr/CHANGES.txt:154 error: solr/CHANGES.txt: patch does not apply error: patch failed: solr/build.xml:187 error: solr/build.xml: patch does not apply
          Hide
          janhoy Jan Høydahl added a comment -

          Attaching new patch which applies to master

          Show
          janhoy Jan Høydahl added a comment - Attaching new patch which applies to master
          Hide
          janhoy Jan Høydahl added a comment -

          Alexandre Rafalovitch can you give it another try?

          Uwe Schindler, do you see the need for more actions than the list below?

          • Commit to master,
          • Modify jenkins config to add solr.javadoc.url for local builds
          • Update website quickstart.mdtext to suggest indexing something else than local javadocs
          Show
          janhoy Jan Høydahl added a comment - Alexandre Rafalovitch can you give it another try? Uwe Schindler , do you see the need for more actions than the list below? Commit to master, Modify jenkins config to add solr.javadoc.url for local builds Update website quickstart.mdtext  to suggest indexing something else than local javadocs
          Hide
          arafalov Alexandre Rafalovitch added a comment -

          It refuses to apply for me on trunc due to trailing whitespace. I tried git apply with various whitespace ignoring options but it does not seem to make a difference. Perhaps because the CHANGES.txt file diff does not apply cleanly as well.

          /Users/arafalov/Downloads/SOLR-9450.patch:53: trailing whitespace.

          /Users/arafalov/Downloads/SOLR-9450.patch:73: trailing whitespace.

          /Users/arafalov/Downloads/SOLR-9450.patch:150: trailing whitespace.
          <xsl:stylesheet version="1.0"
          /Users/arafalov/Downloads/SOLR-9450.patch:157: trailing whitespace.

          /Users/arafalov/Downloads/SOLR-9450.patch:163: trailing whitespace.
          -->
          error: patch failed: solr/CHANGES.txt:224
          error: solr/CHANGES.txt: patch does not apply

          Show
          arafalov Alexandre Rafalovitch added a comment - It refuses to apply for me on trunc due to trailing whitespace. I tried git apply with various whitespace ignoring options but it does not seem to make a difference. Perhaps because the CHANGES.txt file diff does not apply cleanly as well. /Users/arafalov/Downloads/ SOLR-9450 .patch:53: trailing whitespace. /Users/arafalov/Downloads/ SOLR-9450 .patch:73: trailing whitespace. /Users/arafalov/Downloads/ SOLR-9450 .patch:150: trailing whitespace. <xsl:stylesheet version="1.0" /Users/arafalov/Downloads/ SOLR-9450 .patch:157: trailing whitespace. /Users/arafalov/Downloads/ SOLR-9450 .patch:163: trailing whitespace. --> error: patch failed: solr/CHANGES.txt:224 error: solr/CHANGES.txt: patch does not apply
          Hide
          thetaphi Uwe Schindler added a comment -

          I will try this out tomorrow and think about how to configure Jenkins. For Jenkins it would need to build the Javadocs. Is it possible to zip only the link, but still build the full javadocs so it can be copied to Jenkins' Javadocs folder? I mean executing both documentation modes.

          Show
          thetaphi Uwe Schindler added a comment - I will try this out tomorrow and think about how to configure Jenkins. For Jenkins it would need to build the Javadocs. Is it possible to zip only the link, but still build the full javadocs so it can be copied to Jenkins' Javadocs folder? I mean executing both documentation modes.
          Hide
          janhoy Jan Høydahl added a comment -

          Yes it is just another ant target, and package taget depends on both documentation (full javadocs) and documentation-online which makes the link.

          Show
          janhoy Jan Høydahl added a comment - Yes it is just another ant target, and package taget depends on both documentation (full javadocs) and documentation-online which makes the link.
          Hide
          janhoy Jan Høydahl added a comment -

          Alexandre Rafalovitch, works here

          [master2] ~/git/lucene-solr-2$ patch -p1 -i ~/Desktop/SOLR-9450.patch 
          patching file solr/CHANGES.txt
          Hunk #1 succeeded at 246 with fuzz 2 (offset 22 lines).
          Hunk #2 succeeded at 700 (offset 24 lines).
          Hunk #3 succeeded at 977 (offset 24 lines).
          patching file solr/README.txt
          patching file solr/build.xml
          patching file solr/common-build.xml
          patching file solr/site/online-link.xsl
          

          Also pushed it to my GItHub fork if you want to try a merge: https://github.com/cominvent/lucene-solr/tree/solr9450

          Show
          janhoy Jan Høydahl added a comment - Alexandre Rafalovitch , works here [master2] ~/git/lucene-solr-2$ patch -p1 -i ~/Desktop/SOLR-9450.patch patching file solr/CHANGES.txt Hunk #1 succeeded at 246 with fuzz 2 (offset 22 lines). Hunk #2 succeeded at 700 (offset 24 lines). Hunk #3 succeeded at 977 (offset 24 lines). patching file solr/README.txt patching file solr/build.xml patching file solr/common-build.xml patching file solr/site/online-link.xsl Also pushed it to my GItHub fork if you want to try a merge: https://github.com/cominvent/lucene-solr/tree/solr9450
          Hide
          thetaphi Uwe Schindler added a comment -

          Thanks Jan, will test soon! Looks good but not yet tested. It was too late yesterday to understand the ANT logic

          Show
          thetaphi Uwe Schindler added a comment - Thanks Jan, will test soon! Looks good but not yet tested. It was too late yesterday to understand the ANT logic
          Hide
          thetaphi Uwe Schindler added a comment -

          The line <property name="useLocalJavadocUrl" value=""/> in define-solr-javadoc-url is obsolete, as this is not used here. It is only for Lucene to override some stuff (it disables SNAPSHOT mode and is Jenkins related). We may do the same for Solr, but this would require to move the "-SNAPSHOT" check to the groovy script and remove it from the XSL. My suggestion would be to use the same logic like for the Lucene Javadocs URL (same "if" statement) and if the URL is offline, leave it empty. The XSL would just do a check on empty solr-javadoc-url (if its empty) - and not the version - and then print the 2 variants (online or offline).

          In addition, The first line of the groovy script misses type declaration, should be String version = .... It works, but is like Javascript variables without "var".

          I can slightly modify the patch and upload a new one, ok?

          Show
          thetaphi Uwe Schindler added a comment - The line <property name="useLocalJavadocUrl" value=""/> in define-solr-javadoc-url is obsolete, as this is not used here. It is only for Lucene to override some stuff (it disables SNAPSHOT mode and is Jenkins related). We may do the same for Solr, but this would require to move the "-SNAPSHOT" check to the groovy script and remove it from the XSL. My suggestion would be to use the same logic like for the Lucene Javadocs URL (same "if" statement) and if the URL is offline, leave it empty. The XSL would just do a check on empty solr-javadoc-url (if its empty) - and not the version - and then print the 2 variants (online or offline). In addition, The first line of the groovy script misses type declaration, should be String version = ... . It works, but is like Javascript variables without "var". I can slightly modify the patch and upload a new one, ok?
          Hide
          thetaphi Uwe Schindler added a comment -

          Here is my modified patch! I fixed also logging a bit, so the output now contains an explanation of the Javadocs URL like its done for Lucene's.

          Show
          thetaphi Uwe Schindler added a comment - Here is my modified patch! I fixed also logging a bit, so the output now contains an explanation of the Javadocs URL like its done for Lucene's.
          Hide
          thetaphi Uwe Schindler added a comment - - edited

          Here is a more improved patch. As we changed the version properties in the past, the way to detect an official "Solr" release is by comparing version.base with version property. If they are identical, we have an official release (that has doc on web page), otherwise it is some custom stuff (e.g., snapshot or home-made builds like "6.5.0-ubuntu-pkg1").

          Should I commit this or do you want to do this? I would also reconfigure the Jenkins Job building releases to pass its own JOB URL to the new property (next to Lucene's Javadocs link).

          Show
          thetaphi Uwe Schindler added a comment - - edited Here is a more improved patch. As we changed the version properties in the past, the way to detect an official "Solr" release is by comparing version.base with version property. If they are identical, we have an official release (that has doc on web page), otherwise it is some custom stuff (e.g., snapshot or home-made builds like "6.5.0-ubuntu-pkg1"). Should I commit this or do you want to do this? I would also reconfigure the Jenkins Job building releases to pass its own JOB URL to the new property (next to Lucene's Javadocs link).
          Hide
          janhoy Jan Høydahl added a comment -

          Great! Feel free to commit and sync with Jenkins.

          Show
          janhoy Jan Høydahl added a comment - Great! Feel free to commit and sync with Jenkins.
          Hide
          thetaphi Uwe Schindler added a comment - - edited

          Should we do this item separately?

          Update website quickstart.mdtext to suggest indexing something else than local javadocs

          There is also a quickstart.mdext in the checkout's site directory. We should change it there, too.

          Show
          thetaphi Uwe Schindler added a comment - - edited Should we do this item separately? Update website quickstart.mdtext to suggest indexing something else than local javadocs There is also a quickstart.mdext in the checkout's site directory. We should change it there, too.
          Hide
          steve_rowe Steve Rowe added a comment -

          Update website quickstart.mdtext to suggest indexing something else than local javadocs

          There is also a quickstart.mdext in the checkout's site directory. We should change it there, too.

          FYI, there is an Ant target to convert the distribution doc version into the website version - see the last bullet in item #1 here: https://wiki.apache.org/lucene-java/ReleaseTodo#Update_the_rest_of_the_website.

          Show
          steve_rowe Steve Rowe added a comment - Update website quickstart.mdtext to suggest indexing something else than local javadocs There is also a quickstart.mdext in the checkout's site directory. We should change it there, too. FYI, there is an Ant target to convert the distribution doc version into the website version - see the last bullet in item #1 here: https://wiki.apache.org/lucene-java/ReleaseTodo#Update_the_rest_of_the_website .
          Hide
          thetaphi Uwe Schindler added a comment -

          Ah OK, cool.

          Show
          thetaphi Uwe Schindler added a comment - Ah OK, cool.
          Hide
          thetaphi Uwe Schindler added a comment -

          So I think I start with committing the current patch and we can work on improving the documentation.

          Show
          thetaphi Uwe Schindler added a comment - So I think I start with committing the current patch and we can work on improving the documentation.
          Hide
          jira-bot ASF subversion and git services added a comment -

          Commit 894a43b259a72a82f07649b0d93ab3c17c4d89c4 in lucene-solr's branch refs/heads/master from Uwe Schindler
          [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=894a43b ]

          SOLR-9450: The docs/ folder in the binary distribution now contains a single index.html file linking to the online documentation, reducing the size of the download

          Show
          jira-bot ASF subversion and git services added a comment - Commit 894a43b259a72a82f07649b0d93ab3c17c4d89c4 in lucene-solr's branch refs/heads/master from Uwe Schindler [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=894a43b ] SOLR-9450 : The docs/ folder in the binary distribution now contains a single index.html file linking to the online documentation, reducing the size of the download
          Hide
          jira-bot ASF subversion and git services added a comment -

          Commit 9ecc1ec79db7ed2b7f8f7bb4ce6cf93d2ce3c382 in lucene-solr's branch refs/heads/branch_6x from Uwe Schindler
          [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=9ecc1ec ]

          SOLR-9450: The docs/ folder in the binary distribution now contains a single index.html file linking to the online documentation, reducing the size of the download

          Show
          jira-bot ASF subversion and git services added a comment - Commit 9ecc1ec79db7ed2b7f8f7bb4ce6cf93d2ce3c382 in lucene-solr's branch refs/heads/branch_6x from Uwe Schindler [ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=9ecc1ec ] SOLR-9450 : The docs/ folder in the binary distribution now contains a single index.html file linking to the online documentation, reducing the size of the download
          Hide
          thetaphi Uwe Schindler added a comment - - edited

          I updated the Jenkins Jobs for artifacts and added:

          solr.javadoc.url=${JENKINS_URL}job/${JOB_NAME}/javadoc/
          
          Show
          thetaphi Uwe Schindler added a comment - - edited I updated the Jenkins Jobs for artifacts and added: solr.javadoc.url=${JENKINS_URL}job/${JOB_NAME}/javadoc/
          Hide
          thetaphi Uwe Schindler added a comment -

          Actually it's much easier:

          solr.javadoc.url=${JOB_URL}javadoc/
          
          Show
          thetaphi Uwe Schindler added a comment - Actually it's much easier: solr.javadoc.url=${JOB_URL}javadoc/
          Hide
          steve_rowe Steve Rowe added a comment - - edited

          Uwe Schindler, please update https://wiki.apache.org/lucene-java/ReleaseTodo#Update_the_rest_of_the_website with RM instructions for building/uploading the online docs ASAP, so that Jim Ferenczi knows what to do for the 6.5 release.

          Show
          steve_rowe Steve Rowe added a comment - - edited Uwe Schindler , please update https://wiki.apache.org/lucene-java/ReleaseTodo#Update_the_rest_of_the_website with RM instructions for building/uploading the online docs ASAP, so that Jim Ferenczi knows what to do for the 6.5 release.
          Hide
          thetaphi Uwe Schindler added a comment -

          Hi Steve,

          there is nothing special to do. The Javadocs are still built as usual, but no longer packaged into the targz. You will find them after building at the same place as before, so just copy them from your checkout's docs dir.

          Uwe

          Show
          thetaphi Uwe Schindler added a comment - Hi Steve, there is nothing special to do. The Javadocs are still built as usual, but no longer packaged into the targz. You will find them after building at the same place as before, so just copy them from your checkout's docs dir. Uwe
          Hide
          steve_rowe Steve Rowe added a comment -

          Uwe,

          The current instructions https://wiki.apache.org/lucene-java/ReleaseTodo#Push_docs.2C_changes_and_javadocs_to_the_CMS_production_tree say to unpack the release archives and copy from there:

          2. untar the lucene and solr release .tgz to create lucene-X.Y.Z and solr-X.Y.Z. Example:

          tar -xzvf /tmp/releases/6.0.1/lucene-solr-6.0.1-RC2-rev.../lucene/lucene-6.0.1.tgz
          
          tar -xzvf /tmp/releases/6.0.1/lucene-solr-6.0.1-RC2-rev.../solr/solr-6.0.1.tgz
          

          3. Upload via subversion import. Example:
          [...]

          Steve

          Show
          steve_rowe Steve Rowe added a comment - Uwe, The current instructions https://wiki.apache.org/lucene-java/ReleaseTodo#Push_docs.2C_changes_and_javadocs_to_the_CMS_production_tree say to unpack the release archives and copy from there: 2. untar the lucene and solr release .tgz to create lucene-X.Y.Z and solr-X.Y.Z. Example: tar -xzvf /tmp/releases/6.0.1/lucene-solr-6.0.1-RC2-rev.../lucene/lucene-6.0.1.tgz tar -xzvf /tmp/releases/6.0.1/lucene-solr-6.0.1-RC2-rev.../solr/solr-6.0.1.tgz 3. Upload via subversion import. Example: [...] Steve
          Hide
          thetaphi Uwe Schindler added a comment - - edited

          Ah, OK. Then that does not work. We have 2 possibilities:

          • pack a tar.gz with only javadocs
          • or the release person has to copy the javadocs away early, so they don't get changed after release was built (e.g. by pending commits in checkout or by running smoke tester,...).

          What do you think? I would prefer the first in later releases: Just make a docs tar.gz with Lucene and Solr docs? [this would be a future improvement]

          Show
          thetaphi Uwe Schindler added a comment - - edited Ah, OK. Then that does not work. We have 2 possibilities: pack a tar.gz with only javadocs or the release person has to copy the javadocs away early, so they don't get changed after release was built (e.g. by pending commits in checkout or by running smoke tester,...). What do you think? I would prefer the first in later releases: Just make a docs tar.gz with Lucene and Solr docs? [this would be a future improvement]
          Hide
          steve_rowe Steve Rowe added a comment -

          What do you think? I would prefer the first in later releases: Just make a docs tar.gz with Lucene and Solr docs? [this would be a future improvement]

          +1

          For now though the RM will likely have to checkout the release tag and rebuild the Solr docs prior to uploading to the website.

          Show
          steve_rowe Steve Rowe added a comment - What do you think? I would prefer the first in later releases: Just make a docs tar.gz with Lucene and Solr docs? [this would be a future improvement] +1 For now though the RM will likely have to checkout the release tag and rebuild the Solr docs prior to uploading to the website.
          Hide
          thetaphi Uwe Schindler added a comment -

          I opened SOLR-10361 for the solr-docs.tgz file.

          Show
          thetaphi Uwe Schindler added a comment - I opened SOLR-10361 for the solr-docs.tgz file.
          Hide
          thetaphi Uwe Schindler added a comment -

          I will now update the release docs.

          Show
          thetaphi Uwe Schindler added a comment - I will now update the release docs.
          Show
          thetaphi Uwe Schindler added a comment - OK, changed the release documentation: https://wiki.apache.org/lucene-java/ReleaseTodo#Push_docs.2C_changes_and_javadocs_to_the_CMS_production_tree
          Hide
          steve_rowe Steve Rowe added a comment -

          Thanks for taking care, Uwe!

          Show
          steve_rowe Steve Rowe added a comment - Thanks for taking care, Uwe!

            People

            • Assignee:
              thetaphi Uwe Schindler
              Reporter:
              janhoy Jan Høydahl
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development