[DOCU-663] Refresh/Improve documentation of module version handling Created: 19/Jan/16  Updated: 30/Oct/19  Resolved: 30/Oct/19

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: 5.5, 5.6, 5.7, 6.0, 6.1, 5.4, 6.2

Type: Improvement Priority: Neutral
Reporter: Cedric Reichenbach Assignee: Richard Gange
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: 0d
Time Spent: 20m
Original Estimate: Not Specified

Attachments: PNG File versions.png    
Issue Links:
relation

 Description   

Currently, version handling only seems to be covered by a Magnolia 4.5 Doc page and a wiki entry from 2011.

Even though not much has changed technically, it would probably make sense to integrate this information in the latest doc.

One particular detail missing in the old docs is the fact that version handling only works for up to 3 parts (see https://jira.magnolia-cms.com/browse/SUPPORT-5576). It would be great to have this mentioned somewhere.



 Comments   
Comment by Antti Hietala [ 01/Dec/16 ]

Version handling is documented in latest Magnolia CORE docs in Module versions.

However, the fact that the numbering scheme only supports up to three positions (1.2.3) should be added. Versions below the 3rd position are not observed: 1.2.3.4.

Comment by Christoph Meier [ 02/Dec/16 ]

First, yeah, we have to mention that only x.y.z is possible.
2nd: Indeed the documentation for version handling in general is very narrow! And cringele is asking at least since ~2 or 3 years to come with something more useful on documentation.
So, to really make it "good", it should be more then just mentioning the behavior. (But it is a huge topic!)

Comment by Christopher Zimmermann [ 26/Sep/19 ]

I don't see module version handlers documentation there.

We should also add where it makes to use YAML instead of configuration workspace and how this makes migration much easier.

Comment by Richard Gange [ 30/Oct/19 ]

I added the note as Cedric suggest.

As for these other two points that were mentioned:

  • 2nd: Indeed the documentation for version handling in general is very narrow! And Christian Ringele is asking at least since ~2 or 3 years to come with something more useful on documentation.
    So, to really make it "good", it should be more then just mentioning the behavior. (But it is a huge topic!)

  • We should also add where it makes to use YAML instead of configuration workspace and how this makes migration much easier.

I'm not sure I have enough information on what is expected. If I have missed something please create some follow up tickets.

Comment by Richard Gange [ 30/Oct/19 ]

Btw we do have this older docu on version handling. Perhaps we should bring that back? I'm just not sure how relevant that still is.

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