Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Link to correct version of other manual with intersphinx linking #81
This issue was raised by @rowild in Slack:
and @DanielSiepmann added some ideas. Thank you!
The intersphinx linking (as specified in Settings.cfg) currently always go to "latest". This is also the case for older branches.
Should we change the links for the other branches in Settings.cfg to link to matching versions (or best match), e.g. branch 8.7 in "TYPO3 Explained" should link to branch 8.7 in TCA Reference?
There are several related issues (which have also been mentioned in Slack ):
I guess this might work:
All repositories must contain the
For each older branch, we adjust
Once a new LTS is released, e.g. upcoming V10.x, we create a new Branch for older LTS (V9.5) within each repository and render those. Afterwards we can adjust the
This way each version should only contain links to the same version when cross referencing.
It's important to always use Sphinx
We should also coordinate this with Core Team and TYPO3 Inc. As CoreTeam is managing Systemenxtension Manuals and Changelog.
@DanielSiepmann It seems we should use "master" instead of "latest" (see #39), but this does not affect the general principles. But since main branch is currently not being used consistent, I thought I might mention it to see if this is something which must be coordinated with GmbH
I don't think we will always get an exact match.Right now, some repos have "latest" not being 9.5. For "Sitepackage Tutorial", it is 8.7. For "Fronend Localization Guide", it is 7.6. So sometimes it will link to same version and sometimes not (if same version is not available).
That is a little unfortunate, but I think we have to be pragmatic. In most of the cases, the behaviour will be improved.
And improvements in usability with version selector might help here as well.
So, it might look like this?
Settings.cfg of 7.6 branch of "TYPO3 Explained":
I created a patch to make this change in the core as well: https://review.typo3.org/c/Packages/TYPO3.CMS/+/62814