Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCU-2131

Light modules descriptors location and content

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Fixed
    • Neutral
    • None
    • None
    • None
    • None

    Description

      Was looking for how to declare light module dependencies, but searching for "Light module dependencies" got me nowhere. Eventually after reading through "Developing" and not finding what I was looking for I got to "Modules" section and found https://docs.magnolia-cms.com/product-docs/Modules/Module-descriptor.html. However it lists only the location of the descriptors in light modules, but not what the content should be. There's even no link on the page showing pointing to somewhere where the content of the descriptor could be. Finally I've noticed the "YAML-based-module-descriptor" subpage in the menu on the left side, but hell was that an unintuitive way of discovering what i was looking for.
      Not sure how to make it better tho except for more linking from multiple places, linking as close to the sentence or word that person reading documentation could be reading and keeping structure as flat as possible. Tho I'm sure that's nothing new for you. Sorry for the rant, just got really frustrated that it took over 15 minutes to search for this.

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

              amansell Alex Mansell
              had Jan Haderka
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: