migrate doc redirects to redirects.json sidecar from doc-en#1960
Open
jordikroon wants to merge 1 commit into
Open
migrate doc redirects to redirects.json sidecar from doc-en#1960jordikroon wants to merge 1 commit into
jordikroon wants to merge 1 commit into
Conversation
jordikroon
requested review from
derickr,
saundefined,
sgolemon and
sy-records
as code owners
Member
|
Do other languages also need to generate a redirects.xml file? |
Member
Author
|
No. While technically they can, we should only load doc-en. The file is explicitly marked as Though it will be very likely that we will add a variant of redirects.xml to doc-ext (third-party extension manual) in the future. Having the redirects.xml in doc-en (not doc-base) allows us to manage redirects from one PR, rather than having PRs to depend on each other. It also allows a variant in doc-ext in later on. |
derickr
requested changes
Jul 7, 2026
| // 'both' - matches at either entry point | ||
|
|
||
| $docRedirects = is_file(__DIR__ . '/manual/en/redirects.json') | ||
| ? json_decode(file_get_contents(__DIR__ . '/manual/en/redirects.json'), true) |
Member
There was a problem hiding this comment.
json_decode() can also fail of the JSON file is corrupted for some reason. Please guard against that.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The goal for this PR is to migrate all doc related redirects out of web-php.
Instead we generate a
redirects.jsonfromredirects.xmlwhich is then loaded in-place.Redirects not related to docs are NOT migrated. However shortcuts are.
Depends on:
php/phd#260
php/doc-en#5658