[MGNLCDEP-113] DEV DOC: Update Content Dependencies module page Created: 23/Jun/20  Updated: 21/Jun/21  Resolved: 15/Jun/21

Status: Closed
Project: Content Dependencies
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major
Reporter: Leah Staniorski Assignee: Roman Kovařík
Resolution: Fixed 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:
Problem/Incident
is caused by MGNLCDEP-106 Port module to be compatible with new... Closed
Sub-Tasks:
Key
Summary
Type
Status
Assignee
MGNLCDEP-114 DOC: Update Dependencies tab to 6 UI ... Sub-task Closed Roman Kovařík  
MGNLCDEP-117 DOC: Missing referenced dependencies ... Sub-task Closed Roman Kovařík  
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: DOC: update docs for apps/modules migrated to M6
Sprint: UI FW 30
Story Points: 5

 Description   

Original description

It seems that with version 6.2 of Magnolia there were some changes to the Content Dependencies module that are not reflected in the documentation. This is specifically for sections “Dependencies tab” and “Adding Dependencies tab to dialogs”, as well as the screenshots with the 5.7 UI.

Looks like in the code a DependenciesView field was added and these “modules/dependencies/dialogs/tabDependencies” bootstrap files were deprecated. No tab is added into the new Pages and/or Dam app from this module.

How to contribute

Update https://docs.magnolia-cms.com/product-docs/Modules/List-of-modules/Content-Dependencies-module.html to M6 UI where necessary. Use the existing structure as much as possible. Modify the content directly, and do not create an M5 UI version of the app/module.

Pay special attention to the app configuration, module structure/installation, example definitions and screenshots.

NOTE: See also the two related subtasks: MGNLCDEP-114 and MGNLCDEP-117.

Contributing to Magnolia Documentation: https://docs.magnolia-cms.com/product-docs/contribute/index.html



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

https://documentation.magnolia-cms.com/display/DOCS62/Content+Dependencies+module

Comment by Julie Legendre [ 30/Mar/21 ]

From Tobias K in DOCU-2158 (closed as duplicate):

 

The documentation of the content dependencies' module are old.

The definition has to look like this:

!content-type:configSet
name: configSets
label: ConfigSet
  detail: 
    label: ConfigSet
    form: 
      properties: 
        identifier: 
          $type: textField
          name: jcr:uuid
          readOnly: true
          label: Magnolia Id
        purpose: 
          rows: 3
        referencesTo: 
          $type: contentDependencies:dependenciesView
          referencesTo: true
          references: 
            configSetVersions: 
              label: ConfigSetVersion
              appMapping: app:configSetVersions:browser
              workspace: configSetVersion
              referenceProperties: 
                - configSet
      layout: 
        $type: tabbedLayout
        tabs: 
          mainTab: 
            label: Main
            fields: 
              - name: name
              - name: purpose
              - name: jcr:uuid
          dependencies: 
            label: Dependencies
            fields: 
              - name: referencesTo
Generated at Mon Feb 12 00:12:40 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.