[DOCU-963] Refine page "URI mapping" Created: 14/Mar/17  Updated: 29/May/18  Resolved: 02/Aug/17

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: 5.5.6

Type: Task Priority: Neutral
Reporter: Christoph Meier Assignee: Martin Drápela
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Sprint: Docu Sprint 27, Docu Sprint 28, Docu Sprint 29, Docu Sprint 30
Story Points: 8

 Description   

Refine page "URI mapping".
The current version has a focus on travel and multisite.
Where using travel for examples is fine - our docs for this topics should not only show the multisite aspect.

A hidden page from Ruth Multisite work (from Ruth) actually has "better" infos than the current one. (But for sure that one is again multisite related.)

What should the new version of the* Virtual URI mapping* ref. page provide?

  • Explain the general principle of these mappings
  • What mappings are installed by in our modules and bundles? Probably not all, but at least some of them should be showed and explained.
  • Provide a list of the possible arguments for the class attribute, info.magnolia.cms.beans.config.RegexpVirtualURIMapping is just one example. However, to keep it short, we do not have to explain them all.
  • Give some hints and use cases how to use it
    • Remember the example from the "JSON page" ("Turning a template-based JSON provider into a RESTful API with virtualURIMapping", https://goo.gl/aYZIML)
  • Mention the subapp Virtual URI mapping (on the about app), see screenshot

Keep in mind, that API currently undergoes some changes, see:

  1. MAGNOLIA-7016 - Improve API of Virtual URI mappings
  2. MAGNOLIA-3349 - Port Virtual URI mappings to a Registry

(2) is closed, but not yet integrated. It has to wait for (1).
mgeljic and oanh.thai know the exact details about when these changes.

This said, once the 2 dev tickets are done and integrated, we may have to change the "new" docs again.
However it is fine to start with it.



 Comments   
Comment by Mikaël Geljić [ 19/Jun/17 ]

cmeier thanks for putting it together. I agree the changes you propose can be done upfront, independently from the API update & new module.
It will not change much from the conceptual perspective—rather merely use different mapping class names.

Generated at Mon Feb 12 01:13:54 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.