[DOC] Fix changelogs and add hints about outdated state on branches

The changelog is a single file, each major version. This change allows us to avoid porting of changelog files across release-zz.y branches. Most probably we'll introduce single file - each commit changelog approach to avoid all the problems related to our current approach. Relates: #3854 Ports: #3863
TYPO3-Solr · Nov 8, 2023 · 99549d9 · 99549d9
1 parent 43bb8d4
commit 99549d9
Show file tree

Hide file tree

Showing 22 changed files with 315 additions and 335 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -26,9 +26,9 @@ If applicable, add screenshots to help explain your problem.
 **Used versions (please complete the following information):**
  - TYPO3 Version: [e.g. 11.5.26]
  - Browser: [e.g. chrome, safari]
- - EXT:solr Version: [e.g. 11.5.4]
- - Used Apache Solr Version: [e.g. 8.11.1]
- - PHP Version: [e.g. 8.1.0]
+ - EXT:solr Version: [e.g. 12.0.0]
+ - Used Apache Solr Version: [e.g. 9.3.1]
+ - PHP Version: [e.g. 8.2.0]
  - MySQL Version: [e.g. 8.0.0]
 
 **Additional context**

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -66,9 +66,7 @@ jobs:
           echo "BRANCH_NAME="$BRANCH_NAME
           echo -e "matrix : "
           echo $matrix
-          echo ::set-output name=matrix::$(echo $matrix)
-          >&2 echo -e "Example Annotation on error. Is visible in Actions wokflow view."
-          >&2 echo -e "Non-stable releases can not be published to TER. The tag 11.5.0-beta-1 is invalid for TER."
+          echo "matrix=$(echo $matrix)" >> $GITHUB_OUTPUT
       -
         name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v1

diff --git a/.gitignore b/.gitignore
@@ -1,19 +1,21 @@
+*.cache
 .Build
 .buildpath
-*.cache
 .DS_Store
 .idea/
 .project/
 .settings/
 atlassian-ide-plugin.xml
 composer.lock
-Documentation/_make
 Documentation-GENERATED-temp
+Documentation.HTML
+Documentation/_make
 index.php
+Resources/Public/Documentation
 typo3
+typo3_src
 typo3conf
 typo3temp
-typo3_src
 uploads
 var
 vendor
diff --git a/Build/generate_documentation.sh b/Build/generate_documentation.sh
@@ -1,65 +1,34 @@
 #!/usr/bin/env bash
 
-WORKING_DIR=`pwd`
+PRODUCTION_DOCS_PATH="Resources/Public/Documentation"
 
-function doInstallSphinxAndDependencies {
-    sudo apt-get install -y python-pip texlive-base texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended texlive-fonts-extra texlive-latex-base texlive-font-utils python-setuptools python-pygments python-sphinx xzdec make
-    pip install --upgrade t3SphinxThemeRtd requests pygments sphinx==1.5.6 setuptools imagesize pyyaml snowballstemmer t3fieldlisttable t3tablerows t3targets
-
-    # set repo fix to 2015, newer does not work currently(2017.3)
-    tlmgr option repository ftp://tug.org/historic/systems/texlive/2015/tlnet-final
-    tlmgr init-usertree
-    sudo tlmgr update --all
-    sudo tlmgr install ec
-    sudo tlmgr install cm-super
-    # required fonts for PDF rendering
-    sudo mkdir /usr/share/texmf/tex/latex/typo3
-    wget https://raw.githubusercontent.com/TYPO3-Documentation/latex.typo3/7eaec1188da2c8c641d22433d07a4c46ca79a571/typo3.sty -O /tmp/typo3.sty
-    wget https://raw.githubusercontent.com/TYPO3-Documentation/latex.typo3/7eaec1188da2c8c641d22433d07a4c46ca79a571/typo3_logo_color.png -O /tmp/typo3_logo_color.png
-    sudo cp /tmp/typo3.sty /usr/share/texmf/tex/latex/typo3/.
-    sudo cp /tmp/typo3_logo_color.png /usr/share/texmf/tex/latex/typo3/.
-    # apply latex.typo3
-    sudo texhash
-
-    # apply font from TYPO3
-    git clone git://git.typo3.org/Documentation/RestTools.git /tmp/RestTools
-    cd /tmp/RestTools/LaTeX/font
-    ./convert-share.sh
-
-
-    cd $WORKING_DIR
-}
-
-if [ ! -f /usr/share/texmf/tex/latex/typo3/typo3.sty ] ; then
-    echo "Sphinx & co. is not installed, proceed installation..."
-    echo "This may take some time..."
-    sleep 3
-    doInstallSphinxAndDependencies
+if [[ "$IS_DDEV_PROJECT" == 1 || "$IS_DDEV_PROJECT" == "true" ]]; then
+  >&2 echo "Can not run inside ddev container. Please use this command on host only."
+  exit 1
 fi
 
-
-if [ ! -d Documentation/_build/ ] ; then
-    mkdir Documentation/_build/
-elif [ -f Documentation/_build/latex/*.pdf ] ; then # Cleanup previous PDF builds
-    rm -Rf Documentation/_build/{latex,latexpdf.output.log,warnings.txt}
+if ! command -v docker &> /dev/null; then
+  >&2 echo "Docker is not installed on system, please install docker on your host to proceed."
+  exit 1
 fi
 
-echo "Building latex, which is needed for pdf rendering."
-echo "Please check output, which can contain a hints for the errors in your documents."
-sleep 3
-LANG=en_US.UTF-8
-sphinx-build -b latex -c Documentation -d Documentation/_build/doctrees -w Documentation/_build/warnings.txt -D latex_paper_size=a4 Documentation Documentation/_build/latex
-
-
-echo "Building PDF file. This may take some time..."
-'/usr/bin/make' -C 'Documentation/_build/latex' clean all-pdf > Documentation/_build/latexpdf.output.log 2>&1
+if ! command -v dockrun_t3rd &> /dev/null; then
+  echo "The command \"dockrun_t3rd\" is not initialized on system."
+  echo "Making \"dockrun_t3rd\" available in current script."
+  if [[ "$(docker images -q ghcr.io/t3docs/render-documentation 2> /dev/null)" == "" ]]; then
+    docker pull ghcr.io/t3docs/render-documentation && docker tag ghcr.io/t3docs/render-documentation t3docs/render-documentation
+  fi
+  # shellcheck disable=SC2034
+  DOCKRUN_FN_QUIET=1
+  # shellcheck disable=SC1090
+  source <(docker run --rm ghcr.io/t3docs/render-documentation show-shell-commands)
+fi
 
+dockrun_t3rd makehtml-no-cache
 
-if [ -f Documentation/_build/latex/*.pdf ] ; then
-    mv Documentation/_build/latex/*.pdf Documentation/_build/.
-    echo "Done! You can find your PDF file inside Documentation/_build/"
-else
-    echo "Something has gone wrong! Please check the output above and following log files:"
-    echo "    Documentation/_build/latexpdf.output.log"
-    echo "    Documentation/_build/warnings.txt"
+if [[ "$BUILD_DOCS_FOR_PRODUCTION" == 1 || "$BUILD_DOCS_FOR_PRODUCTION" == "true" ]]; then
+  rm -Rf "${PRODUCTION_DOCS_PATH}" "Documentation.HTML"
+  mv -v "Documentation-GENERATED-temp/Result/project/0.0.0" "${PRODUCTION_DOCS_PATH}"
+  ln -s "${PRODUCTION_DOCS_PATH}" "Documentation.HTML"
+  rm -Rf "Documentation-GENERATED-temp"
 fi
diff --git a/Documentation/Appendix/VersionMatrix.rst b/Documentation/Appendix/VersionMatrix.rst
@@ -1,86 +1,25 @@
 .. include:: /Includes.rst.txt
-
-
 .. _appendix-version-matrix:
 
 Appendix - Version Matrix
 =========================
 
-Supported versions
-------------------
-
-Supported versions
-------------------
-
-List of EXT:solr versions and the matching versions of Apache Solr and TYPO3 that are supported:
-
-========= ========== ========== =========== =============== ================== ================================ =============== =============== =================
-       Basic components                Funding contribution extensions          Published funding contribution    Extensions         Solr configuration
-------------------------------- ---------------------------------------------- -------------------------------- --------------- ---------------------------------
-TYPO3     EXT:solr   EXT:tika   EXT:solrfal EXT:solrconsole EXT:solrdebugtools EXT:solrfluidgrouping            EXT:solrmlt     Apache Solr     Configset
-========= ========== ========== =========== =============== ================== ================================ =============== =============== =================
-12.4      12.0       12.0       12.0        12.0 (Ø)        12.0               N/A (integrated in EXT:solr)     12.0 (Ø)        9.3.0           ext_solr_12_0_0
-11.5      11.5       11.0       11.0        11.0            11.0               11.0                             11.0 (Ø)        8.11.1          ext_solr_11_5_0
-========= ========== ========== =========== =============== ================== ================================ =============== =============== =================
-
-| Ø  - not yet available
-| ᾱ  - non stable alpha release
-| β  - non stable beta release
-| rc - release candidate available
-
-.. important::
-
-    | Non-stable releases are not available in TER, but
-    | via Composer or as a ZIP file attachment on GitHub `release <https://github.com/TYPO3-Solr/ext-solr/releases>`_ page.
-
-
-Extended Long Term Support (ELTS)
----------------------------------
-
-Since January 2022, we have been following the TYPO3 release cycles and actively support the last two TYPO3 versions; in addition, we offer ELTS support for
-selected older versions. The following table illustrates the offers and available and upcoming versions:
-
-========= =========== ========== =========== =============== ================== =============== ====================
-       Basic components                 Funding contribution extensions                 Solr configuration
--------------------------------- ---------------------------------------------- ------------------------------------
-TYPO3     EXT:solr    EXT:tika   EXT:solrfal EXT:solrconsole EXT:solrdebugtools Apache Solr     Configset
-========= =========== ========== =========== =============== ================== =============== ====================
-10.4      11.2.4+ Ø   10.0       10.0        10.0            10.0               9.2.1           ext_solr_11_2_0_elts
-9.5-10.4  11.0.8+     6.0.3+     8.0.2+      4.0.2+          1.1.3+             9.2.1           ext_solr_11_0_0_elts
-========= =========== ========== =========== =============== ================== =============== ====================
+.. seealso::
 
-Our Apache Solr for TYPO3 EB-partners newsletter will keep you updated!
+    You are on docs for EXT:solr |release| version, please refer to `Version Matrix on main release <https://docs.typo3.org/p/apache-solr-for-typo3/solr/main/en-us/Releases/Index.html>`_ to see all versions.
 
-Ø - not yet available
+.. tip::
 
-No longer supported versions
-----------------------------
+   There is EXT:solr v11.6 for TYPO3 11.5 LTS.
 
-========= ========== ========= =========== =============== ================== =========== =========== ================
-TYPO3     EXT:solr   EXT:tika  EXT:solrfal EXT:solrconsole EXT:solrdebugtools EXT:solrmlt Apache Solr Configset
-========= ========== ========= =========== =============== ================== =========== =========== ================
-10.4      11.2.0-3   10.0      10.0        10.0            10.0               10.0        8.11        ext_solr_11_2_0
-10.4      11.1       10.0      10.0        10.0            10.0               10.0        8.9         ext_solr_11_1_0
-9.5-10.4  11.0.0-7   6.0.0-2   8.0.0-1     4.0.0-1         1.1.2              3.1         8.5         ext_solr_11_0_0
-9.5       10.0       5.0       7.0         3.0             1.1.1              3.0         8.2         ext_solr_10_0_0
-8.7-9.5   9.0        4.0       6.0         2.0             1.1.0              3.0         7.6         ext_solr_9_0_0
-8.7       8.1        3.1       5.1         1.0             1.0.0              2.0         6.6         ext_solr_8_1_0
-8.7       8.0        3.0       5.0         N/A             N/A                N/A         6.6         ext_solr_8_0_0
-8.7       7.5        2.4       4.2         N/A             N/A                N/A         6.6         ext_solr_7_5_0
-8.7       7.0        2.4       4.2         N/A             N/A                N/A         6.3         ext_solr_7_0_0
-========= ========== ========= =========== =============== ================== =========== =========== ================
 
-Obsolete versions
------------------
+Requirements for EXT:solr* 11.5 stack
+-------------------------------------
 
-========== ========= ========= =========== ============= ================ ================ =========== ======================== ======================== ============
-TYPO3      EXT:solr  EXT:tika  EXT:solrfal EXT:solrfluid EXT:solrgrouping EXT:solrmlt      Apache Solr Schema                   Solrconfig               Accessplugin
-========== ========= ========= =========== ============= ================ ================ =========== ======================== ======================== ============
-7.6 - 8.x  6.5       2.3       4.1         2.0           1.3              N/A              6.6.2       tx_solr-6-5-0--20171023  tx_solr-6-5-0--20171023  2.0
-7.6 - 8.7  6.1       2.3       4.1         2.0           1.3              N/A              6.3         tx_solr-6-1-0--20170206  tx_solr-6-1-0--20161220  2.0
-7.6        6.0       2.2       4.0         1.2           1.3              N/A              6.3         tx_solr-6-0-0--20161209  tx_solr-6-0-0--20161122  1.7
-7.6        5.1       2.1       3.2         1.2           1.3              N/A              4.10        tx_solr-5-1-0--20160725  tx_solr-4-0-0--20160406  1.3
-7.6        5.0       2.1       3.1         1.0           1.3              N/A              4.10        tx_solr-4-0-0--20160406  tx_solr-4-0-0--20160406  1.3
-7.6        4.0       2.1       3.0         N/A           1.2              N/A              4.10        tx_solr-4-0-0--20160406  tx_solr-4-0-0--20160406  1.3
-6.2 - 7.6  3.1       2.0       2.1         N/A           1.1              1.1              4.10        tx_solr-3-1-0--20150614  tx_solr-3-1-0--20151012  1.3
-========== ========= ========= =========== ============= ================ ================ =========== ======================== ======================== ============
+========= ========== ========== =========== =============== ================== ============================= =============== =============== =================
+       Basic components                Funding contribution extensions          Published funding contribution extensions         Solr configuration
+------------------------------- ---------------------------------------------- --------------------------------------------- ---------------------------------
+TYPO3     EXT: solr  EXT:tika   EXT:solrfal EXT:solrconsole EXT:solrdebugtools EXT:solrfluidgrouping         EXT:solrmlt     Apache Solr     Configset
+========= ========== ========== =========== =============== ================== ============================= =============== =============== =================
+11.5      11.5       11.0       11.0        11.0            11.0               11.0                          11.0 (Ø)        8.11.1          ext_solr_11_5_0
+========= ========== ========== =========== =============== ================== ============================= =============== =============== =================
diff --git a/Documentation/Development/Index.rst b/Documentation/Development/Index.rst
@@ -19,4 +19,5 @@ There are many ways to extend and hook into EXT:solr to customize EXT:solr for y
         CI
         CodeStructure
         Signals
+        Events
         ViewHelpers
-Original file line number
+Diff line change
@@ Expand Up @@
             CI
             CodeStructure
             Signals
+            Events
             ViewHelpers