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

Write better module descriptions for Magnolia Store

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • Neutral
    • None
    • None
    • content
    • None

    Description

      Go through the module list in Magnolia Store and verify that each module has a description.

      Guideline:

      • Description should be a concise, interest-triggering summary of the module's purpose and features.
      • Aim for 25 words for the short description on the module list. Good example: Content Translation Support. Don't repeat the module name, it's already on the list.
      • Aim for 100-150 words for the long description on the module page. Good example: Content Dependencies.
      • If no module description can be found or the existing description is too short or badly written, write a new one. Use the material in the module article to summarize the module's capabilities.
      • Add a bulleted lists of features if it works better than a narrative paragraph.
      • If a screenshot helps a reviewer understand the module, attach a screenshot.
      • Verify that the module page has a More Info link that points to an article on documentation site. Make a list of modules that are missing such link, for example Imaging.
      • If a module is listed on the Store but no article exists on documentation site, make a list non-documented modules in this ticket.

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

              ahietala Antti Hietala
              ahietala Antti Hietala
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

                Created:
                Updated:

                Checklists

                  Task DoR