71960[DOCS] Documentation for EXT:redirects
Commit message
Review
-
Code review CR +2 Done
- Christian Kuhn +2
- Oli Bartsch +1
- Stefan Bürk +1
- Alexander Nitsche +1
-
Verified V +2 Done
- Christian Kuhn +2
- Oli Bartsch +1
- Stefan Bürk +1
- Alexander Nitsche +1
- core-ci +1 CI
Issues 1
Files 21
- typo3/sysext/redirects/Documentation/Basics/Index.rst5new+131 −0
- typo3/sysext/redirects/Documentation/BestPractices/Index.rst3new+114 −0
- typo3/sysext/redirects/Documentation/Images/EditAction.pngnewbinary
- typo3/sysext/redirects/Documentation/Images/RedirectActionButtons.pngnewbinary
- typo3/sysext/redirects/Documentation/Images/RedirectAllowedExcludefields.pngnewbinary
- typo3/sysext/redirects/Documentation/Images/RedirectDetective.pngnewbinary
- typo3/sysext/redirects/Documentation/Images/RedirectEdit.pngnewbinary
- typo3/sysext/redirects/Documentation/Images/RedirectList.pngnewbinary
- typo3/sysext/redirects/Documentation/Images/RedirectRevert.pngnewbinary
- typo3/sysext/redirects/Documentation/Images/RedirectsEditStatistics.pngnewbinary
- typo3/sysext/redirects/Documentation/Images/RedirectsMenu.pngnewbinary
- typo3/sysext/redirects/Documentation/Images/SystemReportConflicts.pngnewbinary
- typo3/sysext/redirects/Documentation/Installation/Index.rstnew+14 −0
- typo3/sysext/redirects/Documentation/Introduction/Index.rst2new+63 −0
- typo3/sysext/redirects/Documentation/KnownProblems/Index.rstnew+9 −0
- typo3/sysext/redirects/Documentation/Setup/Index.rst4new+234 −0
- typo3/sysext/redirects/Documentation/Usage/Index.rst14new+301 −0
- typo3/sysext/redirects/Documentation/Includes.rst.txtnew+17 −0
- typo3/sysext/redirects/Documentation/Index.rst2new+50 −0
- typo3/sysext/redirects/Documentation/Settings.cfgnew+70 −0
Show 1 more file
Review log 6487
Show 4262 earlier messages
-
Sybille Peters uploaded patch set 1 10/24/21, 10:42
-
core-ci voted on patch set 1 V +1 10/24/21, 11:08 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18491
-
Sybille Peters uploaded patch set 2 10/24/21, 17:46
-
core-ci voted on patch set 2 V +1 10/24/21, 17:58 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18508
-
Sybille Peters uploaded patch set 3 10/25/21, 14:01
-
Sybille Peters uploaded patch set 4 10/25/21, 14:02
-
core-ci voted on patch set 3 V +1 10/25/21, 14:36 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18534
-
core-ci voted on patch set 4 V +1 10/25/21, 14:38 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18535
-
Sybille Peters uploaded patch set 5 10/25/21, 16:52
-
Sybille Peters marked it ready for review 10/25/21, 16:52
-
core-ci voted on patch set 5 V +1 10/25/21, 17:10 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18545
-
Sybille Peters uploaded patch set 6 10/25/21, 17:17
-
Sybille Peters uploaded patch set 7 10/25/21, 17:29
-
core-ci voted on patch set 6 V +1 10/25/21, 17:40 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18548
-
Sybille Peters uploaded patch set 8 10/25/21, 17:43
-
core-ci voted on patch set 7 V +1 10/25/21, 17:44 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18550
-
core-ci voted on patch set 8 V +1 10/25/21, 18:00 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18551
-
Sybille Peters uploaded patch set 9 10/26/21, 06:56
-
core-ci voted on patch set 9 V +1 10/26/21, 07:09 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18563
-
Sybille Peters uploaded patch set 10 10/26/21, 19:39
-
Sybille Peters commented on patch set 10 10/26/21, 19:41
Information for reviewing: -------------------------- To render the documentation with Docker locally, please see https://docs.typo3.org/m/typo3/guide-contributionworkflow/master/en-us/AddingDocumentation/Index.html#render-the-changelog except switch to typo3/sysext/redirects and generate there. Information for backporting: --------------------------- When backporting to 10.4 and 9.5 some parts must be removed. If set as reviewer, I can make the changes. >= 11 only : creation date of redirects >= 11 only : allow ordering >= 11 only : "cleanup" task >= 10 only : automatic slug update and redirect creation on slug change >= 10 only : checkintegrity command and information in report (conflicting redirects) -
core-ci voted on patch set 10 V +1 10/26/21, 20:09 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18586
-
Christian Kuhn updated the commit message in patch set 11 10/26/21, 20:17
-
Christian Kuhn commented on patch set 11 10/26/21, 20:17
adapted releases line: v9 is not a topic anymore. -
Christian Kuhn commented on patch set 11 10/26/21, 20:21
README.rst:1shouldn't this file be Documenation/Index.rst? -
Sybille Peters commented on patch set 11 10/26/21, 20:27
README.rst:1ReplyI left it as one file to make review easier. There are actually 2 options: 1. Use one README.(rst|md) 2. Use multiple files in Documentation (with Index.rst). Personally I am starting to prefer the 1 file solution if the documentation is not very long. But, to avoid lengthy discussions, I'll just change it. Pushing another patch ... -
core-ci voted on patch set 11 V +1 10/26/21, 20:37 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18591
-
Sybille Peters uploaded patch set 12 10/26/21, 20:40
-
Sybille Peters commented on patch set 12 10/26/21, 20:41
README.rst:1ReplyDone -
Sybille Peters uploaded patch set 13 10/26/21, 20:47
-
core-ci voted on patch set 12 V +1 10/26/21, 21:03 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18598
-
core-ci voted on patch set 13 V +1 10/26/21, 21:07 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18599
-
Guido Schmechel commented on patch set 13 10/26/21, 21:57
Beautiful documentation! In general, I would still like to see the topic of performance addressed. For example, working with folders and RegExp instead of manually creating hundred of pages. In addition, perhaps a separate explanation of the status codes would be good? In v10, I don't think the status codes are described in the backend.Index.rst:43ba = beIndex.rst:88enable = enabled -
Sybille Peters commented on patch set 13 10/26/21, 22:12
Reply
Thank you. About performance: I would have to do more research to write about that and not sure currently. You could write performance could be a problem with a large number of redirects, esp. with regex. Sounds a little vague. I will think about it, but maybe that is something that could be added later? Yes, about the status codes, that might be a good idea.Index.rst:43ReplyAckIndex.rst:88ReplyAck -
Sybille Peters uploaded patch set 14 10/26/21, 22:14
-
core-ci voted on patch set 14 V +1 10/26/21, 22:30 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18604
-
Sybille Peters commented on patch set 14 V -1 10/27/21, 07:31
Working on it ... -
Guido Schmechel commented on patch set 14 10/27/21, 07:52
Reply
Of course, this can also be done later, and it certainly doesn't affect many people at the moment. We have 2-3 tickets where it's about the performance. Everything is packed into an array and then, as an example, the 100 entries are slower than the one for RegEx. -
Sybille Peters uploaded patch set 15 10/27/21, 08:59
-
Sybille Peters commented on patch set 15 10/27/21, 09:00
Added some missing texts for introduction, usage and glossary, see diffs between last patchsets: https://review.typo3.org/c/Packages/TYPO3.CMS/+/71960/14..15 -
core-ci voted on patch set 15 V +1 10/27/21, 09:13 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18610
-
Stefan Bürk commented on patch set 15 10/28/21, 08:47
Reply
@Guido Schmechel If I got you right, you mean that for autoCreateRedirect, the redirect module should create only "one regexp" rule instead of xxx single redirects if subPages are updated too ? That's not generally handable in a non buggy way. Anyway you may choose to deactivate the default redirects Hook and implement an own handler for that matching your instance needs. Having a lot of redirects has performance redirects at all. But anyway, flat redirects "are" better then regexp. If you have a couple of regexp they are all validated on each request which makes a shift to regexp not better. Will talk with Sybille, on how to add some "advices" or "hints" which should be taken in account, but in the end the redirects implementaion in core/php side can not be performant for a lot of redirects, which makes it a performance hog for huge installations, or installations with a lot of pates/ root sites etc. From my side, the redirects module is a start to get some redirects in. It's not a full solution. At some point it is not suitable anymore, and you have to came up with alternatives, which is out of the scope of the core. Like page cache in db/redis and adding a page cache in front like varnish or something like that. But you are right that we should made some statements that there may be performance issues hit, if not taking care.Thanks Sybille for that documentation for the redirects extension and your work on that, putting all that information togheter. (I wished I had that documention when we started using it in projecets). Anyway I have added some comments on some parts. Questions but also some suggestions. Do not take them all as "blocker". They are added to be discuessed and thought about it. I'm up for other opionens, and after talking about it most of them, even if not taken into account would not prevent a +1 from me. At all I would love to see having a first documention in as fast as possible, even if it would not be complete at all. Extending can be done over time. And for a start it is nice written and understandable, I think. Good work and again, thanks for your time on this.Index.rst:48Should be somehow made highligted - or moved to "What does it not do" or something like that. At least some "notice/info" box highlighting (if this is possible)Index.rst:34Need to recheck, but I would bet that these options are used for auto redirect creation. Not if user adds redirects. Should be checked and eventually noted in a comment if it is so. (Than naming is likely misleading choosen, but could not be changed without beeing breaking).Index.rst:109That's true. There is a patch pending which would make this working, as a sideeffect to fix the other issue. Reasons was that relative was not regonized as a valid linkhandling type (unknown) and as such was unhandeled in any way. https://review.typo3.org/c/Packages/TYPO3.CMS/+/71889 Anyway I would suggest to add at least another warning here, that for regexp with capture groups no capture group replacement can be done for 't3://' styled targets (currently). Not for the pure t3 link, and also not for the resolved at the end.Index.rst:144'(.*)' is a bad example, as it is to broad. If regepx redirect is configured with 'respect_query_parameters===true', and a request has query parameters this group will match the query part also: ``` https://mysite/path/something?param=value1 ``` I have added a check to strip "queryparameters" for caputre group replacement, but I would like to see if we can add here some notes to be restrictive about capture groups definitions - or at least note this. I do not thing that most peoples would think that that would matche query parameters also. Maybe we should do for the example a more strict regexp definition: ``` #^/path/([a-zA-Z]{1}[a-zA-Z0-9_/-]+)# ``` Anyway we should mention that regexp redirects should be carefully tested with some sort of regexp testing tools. Not sure about policy here and if it is allowed to link eventually online tool(s) as examples. At least that there my be some. In future I would love to see more and fine granualuar examples, maybe in subpages. But for now, and to get a documentation started for redirect extension this should be okay for now (better this as no documentation at all).Index.rst:162Only note/hint: Pending patch to allow capture group relative targets also: https://review.typo3.org/c/Packages/TYPO3.CMS/+/71889 Even with that patch, capture group replacement for "t3://" styled links or page id styled links (integer, not beginning with '/' or an valid scheme like 'http(s)://', 'tel://' or 'email://' which would handled by linkhandler stack. Maybe keep that in mind and rephrase this to mention the t3 issue if the other patch got merged ?Index.rst:164@Sybille ping me here on slack, if you need some explanation here. Maybe we can came up with some sort of "simple" explanation for it.Index.rst:179There is another option which is not mentioned here, but has influence on auto creating redirects and updates: ``` # update (regenerate) slugs of children pages based on configuration autoUpdateSlugs: true/false ``` What's important to know between these two options is following: ``` # subPages are not checked/processed. Not updated and thus no redirects # created for it. autoUpdateSlugs: false # subPages are checked and slug updated/regenerated based on configuration. # if autoCreateRedirects === true, redirects for subPages slug changes are # greated too, otherwise only slugs are updated autoUpdateSlugs: true # slug is updated, but no redirect created. Not for the current page, and also # not for changed subPages slugs, if they where changed after update/regeneration autoCreateRedirects: false # create redirect recod for changed slug. If autoUpdateSlugs === true, redirects # for changed subpages slugs are created too. autoCreateRedirects: true ``` I know there are more options. Maybe we should explain them at all ? Like the ttl option and the http status code? As they are all related to the autocreation. Maybe we should spend that part a seperate page, so it can be linked from Setup/SiteConfiguration too for deeper explanation ?Index.rst:193Should be made more prominent. Maybe in a hint(info) or warning box ? -
Sybille Peters uploaded patch set 16 10/30/21, 14:54
-
Sybille Peters commented on patch set 16 10/30/21, 15:03
Reply
Stefan will comment later.Pushed another version. All review comments up to here should have been addressed (and marked as resolved). For the topic of performance and more examples for regex - we kept this short for now, can be added in later patch. This text was added in collaboration with Stefan about performance - is difficult to address and more must be postponed for now (but he wanted to comment on that topic himself too): https://review.typo3.org/c/Packages/TYPO3.CMS/+/71960/16/typo3/sysext/redirects/Documentation/BestPractices/Index.rst#27 We managed to remove 2 warnings pointing out problems which have been fixed in the meantime. That is great! Usually, it is not customary to point out issues in documentation but in some cases we still do give warnings or point to possible problems - only where it is deemed necessary to give guidance so people do not run into problems. Hope is ok now, but do not hesitate to point out problems, but if there are things missing, might be better to add in followup patch.Index.rst:48ReplyInfobox added.Index.rst:34ReplyI agree that should be made clearer. I tested - it only affects the automatically created redirects. If new redirect is created manually, default is still 307 (at least that is how it is right now - is set in TCA to 307, so one could also change it, I guess).Index.rst:109Reply71889 is now merged, is removed.Index.rst:144ReplyI replaced the .* but would like to keep this open as there is more to be considered ... Changes not pushed yet.Index.rst:162ReplyIs fixed!!!! Warning removed.Index.rst:164ReplyThere is mostly just confusion from my end about a) what is the correct term for something like t3://page?uid=124&_language=0. (typolink, typoUri, ...?) b) where is the format for this documented? Posted question for a) now in coredev. If can be clarified, ok. If not, I would probably prefer to postpone this.Index.rst:179ReplyWe removed the settings here. The settings are already mentioned on the "Setup" page. We link to the site configuration now.Index.rst:193ReplyDone. -
core-ci voted on patch set 16 V +1 10/30/21, 15:15 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18671
-
Sybille Peters uploaded patch set 17 10/30/21, 15:17
-
Sybille Peters commented on patch set 16 CR -1 10/30/21, 15:29
Working on some formatting improvements -
Stefan Bürk voted on patch set 17 CR -1 10/30/21, 15:34
-
core-ci voted on patch set 17 V +1 10/30/21, 15:34 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18673
-
Sybille Peters uploaded patch set 18 10/31/21, 09:54
-
Sybille Peters commented on patch set 18 10/31/21, 10:00
with last patch: - changed formatting in Usage for less cluttered look - clarified some part which were not explained clearly - added more screenshots - Best practice: Added section for editors. IMHO too many redirects and the performance impact it comes may also be a result of too many slug changes which do not always make sense. So more focus on managing editors is a good idea IMHO. Does not mean we cannot enhance performance section too! https://review.typo3.org/c/Packages/TYPO3.CMS/+/71960/18/typo3/sysext/redirects/Documentation/BestPractices/Index.rst#44 Also, editors do not be default have access to exclude fields, so they cannot create regex - even if access to redirects module. Hope that is clear enough. -
core-ci voted on patch set 18 V +1 10/31/21, 10:10 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18696
-
Chris Müller voted on patch set 18 V +1 CR +1 10/31/21, 12:36
-
Stefan Bürk uploaded patch set 19 11/01/21, 09:59
-
Sybille Peters commented on patch set 19 CR -1 11/01/21, 10:01
on it ... -
Stefan Bürk commented on patch set 19 11/01/21, 10:02
Reply
@Guido Schmechel We have added a small point on the best practise page, Sybillie will fix my "language style issues" but would be such a part good enough for the start for you ? -
core-ci voted on patch set 19 V +1 11/01/21, 10:16 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18712
-
Sybille Peters uploaded patch set 20 11/01/21, 11:27
-
Sybille Peters voted on patch set 20 V +1 CR +1 11/01/21, 11:28
-
Chris Müller voted on patch set 20 V +1 CR +1 11/01/21, 11:43
-
core-ci voted on patch set 20 V +1 11/01/21, 11:48 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18719
-
Stefan Bürk voted on patch set 20 V +1 CR +1 11/01/21, 11:59
-
Susi Moog commented on patch set 20 CR +1 11/01/21, 12:50
Cool to see another sysext getting a documentation 👍 I read through it and would say it's fine to be merged as is as it's the initial version (and already good - don't get me wrong ;)). I would propose to look at three things (from the documentation perspective) at a later point: - global glossary: especially for terms like slugs we should have a central glossary to avoid repeating / duplicated information - automated screenshots: thanks to Lina/Alexanders tool, we should be able to automate most of the screenshots here - fine-tune the wording: I'd let Tom review the manual from a native speakers' point of view to polish the English Thanks again for all your work on this! -
Nikita Hovratov commented on patch set 20 11/01/21, 15:16
Index.rst:65redirectsIndex.rst:114conflict -
Sybille Peters commented on patch set 20 11/01/21, 15:29
Index.rst:65ReplyThanks. Should get fixed. I will wait a bit in case more review comments come and we can fix in one batch. -
Sybille Peters uploaded patch set 21 11/02/21, 07:00
-
Sybille Peters commented on patch set 21 V +1 CR +1 11/02/21, 07:00
Index.rst:65ReplyDoneIndex.rst:114ReplyDone -
Stefan Bürk voted on patch set 21 V +1 CR +1 11/02/21, 07:01
-
core-ci voted on patch set 21 V +1 11/02/21, 07:20 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18735
-
Nikita Hovratov voted on patch set 21 V +1 CR +1 11/02/21, 07:30
-
Alexander Nitsche commented on patch set 21 CR -1 11/02/21, 09:38
Note: The screenshots could be generated via the TYPO3 Screenshots project too. This would facilitate further maintenance. See https://github.com/TYPO3-Documentation/t3docs-screenshots.Index.rst:6Headers should start with double equal sign lines like on the other pages. => ====== Basics ======Index.rst:91Start all headers with uppercase, not?Includes.txt:1The current filename is Includes.rst.txt, at least in the t3docs projects. Probably due to syntax highlighting reasons in the IDE.Index.rst:37The current phrasing is "Edit on GitHub". -
Sybille Peters commented on patch set 21 11/02/21, 10:17
on it. will work on this after lunch.Index.rst:6ReplyYou are right. I usually do it this way, but for some reason messed up here.Index.rst:91ReplyAckIncludes.txt:1ReplyI used the latest EXT:adminpanel for reference. It would be nice if all extensions adhered to the standards. I am aware of most of the conventsions but don't have them all in my head. (I don't really know if this is beneficial for syntax highlighting, but will just use documented standard). Will fix.Index.rst:37ReplyAck -
Sybille Peters commented on patch set 21 11/02/21, 10:22
Reply
About the screenshots - we talked about this. Can be done with followup patch. Please talk with Lina / Susi about this. -
Alexander Nitsche commented on patch set 21 11/02/21, 18:00
The images folder should be renamed to "Documentation/Images" - to be aligned with the other system extensions. -
Sybille Peters uploaded patch set 22 11/02/21, 21:18
-
Sybille Peters commented on patch set 22 V +1 CR +1 11/02/21, 21:18
Reply
Not resolved but would like to close - as mentioned.Index.rst:6ReplyDoneIncludes.txt:1ReplyDone -
core-ci voted on patch set 22 V +1 11/02/21, 21:38 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18767
-
Chris Müller voted on patch set 22 V +1 CR +1 11/03/21, 06:45
-
Alexander Nitsche commented on patch set 22 CR -1 11/03/21, 08:32
One very last comment - any further i will postpone like Susi: The images should be named in UpperCamelCase similar to the other system extensions. -
Sybille Peters uploaded patch set 23 11/03/21, 10:06
-
Sybille Peters commented on patch set 23 11/03/21, 10:07
Reply
As discussed on Slack - last change on my end unless something is blocker. Thanks all reviewers! -
Stefan Bürk voted on patch set 23 V +1 CR +1 11/03/21, 10:17
-
Alexander Nitsche commented on patch set 23 V +1 CR +1 11/03/21, 10:17
"There are no Sphinx warnings!" -
core-ci voted on patch set 23 V +1 11/03/21, 10:19 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/18776
-
Christian Kuhn voted on patch set 23 V +2 CR +2 11/03/21, 12:40
-
Oli Bartsch voted on patch set 23 V +1 CR +1 11/03/21, 12:40
-
Christian Kuhn merged patch set 24 11/03/21, 12:40