[DOCU-1191] Update module pages affected by "removal of (old) Content API" Created: 17/Oct/17  Updated: 28/Nov/17  Resolved: 27/Nov/17

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

Type: Story Priority: Neutral
Reporter: Christoph Meier Assignee: Richard Gange
Resolution: Done Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Issue Links:
relation
is related to DOCU-1171 Reflect updates on "Content Translat... Closed
Sub-Tasks:
Key
Summary
Type
Status
Assignee
DOCU-1231 Update "Tools module" page Sub-task Closed Richard Gange  
DOCU-1232 Update "Workflow module" page Sub-task Closed Richard Gange  
DOCU-1233 Update "Form module" page Sub-task Closed Christoph Meier  
DOCU-1234 Update "Imaging module" page Sub-task Closed Richard Gange  
DOCU-1235 Update "Groovy module" page Sub-task Closed Richard Gange  
DOCU-1236 Update "Diff module" page Sub-task Closed Richard Gange  
DOCU-1237 Update "Public User Registration modu... Sub-task Closed Richard Gange  
Template:
Acceptance criteria:
Empty
Date of First Response:
Epic Link: Post-5.6 release outstanding tasks
Sprint: Docu Sprint 36, Docu Sprint 37, Docu Sprint 38
Story Points: 13

 Description   

The epic to get rid of the (old) content API has been started - however, won't be completely finished for Magnolia 5.6(.0).

But some things were already done and will be released together with Magnolia 5.6.

In all affected modules - submodules get new Maven address - which means the modules with the real code get new groupId and/or new artifactId.
We keep "Maven redirects"* pointing to the new artifact (with the new address).

A "maven" redirect is (kind of) a submodule which has only a pom file containing a message which print the information concerning the new Maven address to the console during the build.

As a consequence - we have to update all module pages on DOCS56 for these modules with such changes.

Per module we have to

  • update or add the section with the overview of the submodules
  • changing / adding the macros in order to point them to the "new modules" (with the real code)
    • for downloadable jar files
    • for dependency snippets

Here is the list (work in progress) of the affected modules.

dev ticket module dev what else
MGNLTOOLS-85 Tools module Oanh  
MGNLWORKFLOW-359 Workflow module Oanh special case ... maven-relocation was not possible
. Form module . .
. Content translation support module pmundt lotz of changes, There is an ongoing dev-ticket DEV-659 to support us; and there is distinct DOCU ticket too: DOCU-1171
. Imaging module . .
MGNLGROOVY-168 , MGNLGROOVY-163 Groovy module . See comments from Federico on the ticket!
. Diff module . .
. public-user-registration module . .
. Forum module . The forum module page does not exist anymore in DOCS56

General recipe to update the affected module pages:



 Comments   
Comment by Julie Legendre [ 20/Oct/17 ]

See https://jira.magnolia-cms.com/browse/DEV-610

Comment by Julie Legendre [ 10/Nov/17 ]

note and artifact updated in workflow, forms and tools

Comment by Martin Drápela [ 13/Nov/17 ]

Reviewed: https://documentation.magnolia-cms.com/display/DOCS56/Removal+of+old+Content+API

added an end-page auxiliary subsection titled "The API deprecation as seen through the 4.4 and 4.5 Javadoc APIs" for anyone to easily find the APIs and compare the diffs.

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