Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[BUGFIX][DOC] Version Matrix for TYPO3 11+12 is not rendered #3713

Merged
merged 2 commits into from
Jul 1, 2023
Merged

[BUGFIX][DOC] Version Matrix for TYPO3 11+12 is not rendered #3713

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40a6ef1
[TASK] Make it possible to render the docs in HTML in modern TYPO3 way
dkd-kaehm Jun 30, 2023
f26c985
[BUGFIX][DOC] Version Matrix for TYPO3 11+12 is not rendered
dkd-kaehm Jun 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
79 changes: 24 additions & 55 deletions Build/generate_documentation.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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_PRUCTION" == 1 || "$BUILD_DOCS_FOR_PRUCTION" == "true" ]]; then
rm -Rf "${PRODUCTION_DOCS_PATH}"
mv -v "Documentation-GENERATED-temp/Result/project/0.0.0" "${PRODUCTION_DOCS_PATH}"
ln -sf "${PRODUCTION_DOCS_PATH}" "Documentation.HTML"
rm -Rf "Documentation-GENERATED-temp"
fi
34 changes: 22 additions & 12 deletions Documentation/Appendix/VersionMatrix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,30 @@ 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 (Ø) - (integrated in EXT:solr) 12.0 (Ø) 9.2.1 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
rc - release candidate available
========= ========== ========== =========== =============== ================== ================================ =============== =============== =================
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.2.1 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)
---------------------------------
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Settings.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[general]

project = Apache Solr for TYPO3
version = 12.0.0
version = 12.0
release = 12.0.0
copyright = since 2009 by dkd & contributors

Expand Down
10 changes: 10 additions & 0 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,16 @@
"mkdir -p .Build/vendor/apache-solr-for-typo3",
"[ -L .Build/vendor/apache-solr-for-typo3/solr ] || ln -snvf ../../../. .Build/vendor/apache-solr-for-typo3/solr"
],
"t3:docs:build": [
"rm -Rf Documentation-GENERATED-temp/",
"./Build/generate_documentation.sh"
],
"t3:docs:build:prod": [
"BUILD_DOCS_FOR_PRUCTION=1 $COMPOSER_BINARY t3:docs:build"
],
"t3:docs:clean": [
"rm -Rf Documentation-GENERATED-temp/ $(readlink -f Documentation.HTML) Documentation.HTML"
],
"extension-create-libs": [
"@composer req -d Resources/Private/Php/ComposerLibraries solarium/solarium:$(Build/Helpers/GET_LACAL_PACKAGE_VERSION_CONSTRAINT.sh solarium/solarium)"
],
Expand Down