Uploaded image for project: 'Magnolia UI'
  1. Magnolia UI
  2. MGNLUI-6215

DOC: Restructure uploadField documentation

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • Neutral
    • None
    • 6.2.4
    • None

    Description

      • Using uploadField to upload a file directly to an app's workspace has drawbacks. We decided to call it bad practice and point to the fact using an @MgnlDeprecated annotation in the classes. We should document this at https://documentation.magnolia-cms.com/display/DOCS62/Upload+field. Reasons why it is bad practice:
        • It does not centralize "assets" to a single "asset" workspace, which can be problematic if you want to migrate data to an external DAM.
        • Exports with binaries throw an exception unless configured to XML exports.
        • Binaries increase the space needed by a workspace.
        • Indexing, backup/restore, publishing, difficulties in manipulation (thumbnails, scaling and other operations to be applied).
      • Add information to the uploadField page about best practice (advise to avoid using this field and to use linkField instead. This is already mentioned in the damUploadField page). We should keep the uploadField page in DOCS62, mark it as deprecated and mention that it is not good practice to use the field.
      • damUploadField makes only sense in the context of the Assets app. Details about it should probably be mentioned in the Assets app page instead. So it would be best to move the content there and delete the damUploadField page altogether to avoid suggesting that the field can be used generically in other contexts. The example should be removed too.
      • While damUploadField is not deprecated, it is no longer annotated as a field type. Both UploadFieldDefinition and UploadViewDefinition are now deprecated.
      • Delete both uploadField and damUploadField and their fully qualified class names from https://documentation.magnolia-cms.com/display/DOCS62/Field+definition#Fielddefinition-Fieldtypes.
      • Introduce UploadViewDefinition docs based on this comment:
        • Won't address, see reason in comments below.

      Checklists

        Acceptance criteria

        Attachments

          Issue Links

            Activity

              People

                akhamis Ashraf Khamis
                sdemocko Šimon Demočko
                Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved:

                  Checklists

                    Task DoR