[DOCU-3486] Upgrade Virtual URI mapping documentation Created: 09/Feb/24 Updated: 09/Feb/24 |
|
| Status: | Open |
| Project: | Documentation |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Task | Priority: | Neutral |
| Reporter: | Carlos Cantalapiedra | Assignee: | Martin DrĂ¡pela |
| Resolution: | Unresolved | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||
| Template: | |||||
| Acceptance criteria: |
Empty
|
||||
| Task DoR: |
Empty
|
||||
| Date of First Response: | |||||
| Team: | |||||
| Description |
|
A customer has reported some points that are not properly documented at the Virtual Uri Mapping documentation entry. In the chapter https://docs.magnolia-cms.com/product-docs/6.2/Administration/URI-mapping/Virtual-URI-mapping.html#_examples under "Host-based regex" the YAML is missing a node. Directly above the node mappings should be a freely-named subnode (which is missing in the example) and beneath that, there should be the host and toUri properties, something as:
class: info.magnolia.virtualuri.mapping.HostBasedRegexpVirtualUriMapping
fromUri: /premier/(.*)$
toUri: forward:/404
mappings:
myMapping:
host: example.net
toUri: redirect:/premier-edge/$1
Also would be nice to clarify (may be with a warning or an info box) that the "host" property is not a regex, even if the class name HostBasedRegexpVirtualUriMapping" sounds like that (the name could lead into confusion) Finally, as a reminder or another warning, would be cool to highlight that host works for all subdomains of the defined domain. |
| Comments |
| Comment by Roberto Knoblauch [ 09/Feb/24 ] |
|
Additional point: In the chapter https://docs.magnolia-cms.com/product-docs/6.2/Administration/URI-mapping/Virtual-URI-mapping.html#_virtual_uri_mapping_weights: under "Regexp mappings", the "Regexp" for "HostBasedVirtualUriMapping" is missing. |