TYPO3GmbH / site-intercept

GNU General Public License v2.0
3 stars 7 forks source link

[FEATURE] Add linkToDocs.php helper script #188

Closed garvinhicking closed 1 month ago

garvinhicking commented 1 month ago

Allows to call an "API endpoint" on docs.typo3.org which can redirect to a common intersphinx identifier (like "t3coreapi:caching").

Version dependencies can also be specified.

This is possible by looking up a objects.inv.json file inside the resolved directory of the docs.typo3.org server, parse it, search for the index and then forward to the target URI.

We do not need an aggregator to merge all possible JSON files into one, because we only need to lookup the specific intersphinx repository destination.

Composer dependency 't3docs/typo3-version-handling' is utilized to provide the needed lookup maps between "intersphinx identifier" and actual rendering directory.

Example calls:

https://intercept.ddev.site/services/linkToDocs.php?shortcode=t3renderguides:available-default-inventories

https://intercept.ddev.site/services/linkToDocs.php?shortcode=t3coreapi:caching@12.4

https://intercept.ddev.site/services/linkToDocs.php?shortcode=t3coreapi:caching@11.5

https://intercept.ddev.site/services/linkToDocs.php?shortcode=t3coreapi:caching@main

https://intercept.ddev.site/services/linkToDocs.php?shortcode=typo3-cms-seo:introduction@main

private-packagist[bot] commented 1 month ago

legacy_hook/composer.lock

Package changes

Package Operation From To About
psr/cache add - 2.0.0 view code - License: MIT License
psr/container add - 2.0.2 view code - License: MIT License
psr/log add - 3.0.2 view code - License: MIT License
symfony/cache add - v5.4.44 view code - License: MIT License
symfony/cache-contracts add - v2.5.3 view code - License: MIT License
symfony/polyfill-php73 add - v1.31.0 view code - License: MIT License
symfony/service-contracts add - v3.5.0 view code - License: MIT License
symfony/var-exporter add - v6.4.9 view code - License: MIT License
t3docs/typo3-version-handling add - 0.14.0 view code - License: MIT License
guzzlehttp/guzzle upgrade 7.8.1 7.9.2 diff
guzzlehttp/promises upgrade 2.0.2 2.0.3 diff
guzzlehttp/psr7 upgrade 2.6.2 2.7.0 diff
psr/http-factory upgrade 1.0.2 1.1.0 diff
symfony/deprecation-contracts upgrade v3.4.0 v3.5.0 diff
symfony/finder upgrade v5.4.35 v5.4.43 diff
symfony/polyfill-php80 upgrade v1.29.0 v1.31.0 diff

Dev Package changes

Package Operation From To About
mikey179/vfsstream upgrade v1.6.11 v1.6.12 diff
myclabs/deep-copy upgrade 1.11.1 1.12.0 diff
nikic/php-parser upgrade v5.0.1 v5.2.0 diff
phpunit/php-code-coverage upgrade 10.1.12 10.1.16 diff
phpunit/phpunit upgrade 10.5.11 10.5.35 diff
roave/security-advisories upgrade dev-latest da77e3d dev-latest 4d2e39c diff
sebastian/comparator upgrade 5.0.1 5.0.2 diff
sebastian/environment upgrade 6.0.1 6.1.0 diff

Settings · Docs · Powered by Private Packagist

garvinhicking commented 1 month ago

c/o @NeoBlack - as discussed

private-packagist[bot] commented 1 month ago

The composer.lock diff comment has been updated to reflect new changes in this PR.

private-packagist[bot] commented 1 month ago

The composer.lock diff comment has been updated to reflect new changes in this PR.