Uploaded image for project: '[Read Only] - Hippo Essentials'
  1. [Read Only] - Hippo Essentials
  2. ESSENTIALS-341

Document Essentials Best Practices

    XMLWordPrintable

Details

    • Task
    • Status: Closed
    • Normal
    • Resolution: Fixed
    • None
    • GA
    • None
    • None
    • 6
    • GA Hardening

    Description

      Starting with a brainstorm session, make an inventory of Hippo Best Practices implemented by Essentials, and make a plan how/where to document those. Then do it.

      • Have a standard approach for components to provide a basic rendering in case they need some initial configuration
      • Ensure that components do not introduce additional HTML in preview mode, see XYZ (ask Ard)
      • How to extend / use the existing components
      • Stay up to date with recent CMS releases
      • Separate configuration and content bootstrap resources
      • Handle page-not-found in case there is no sitemap item matching or the matching sitemap item is missing content.
      • Make sure to add a limit when executing queries
      • Make use of iterators rather than fetching data in a list
      • Provide catalog components with parameter info annotations to allow component management through the channel manager
      • Check user input against malicious data
      • Use Resource Bundles for static labels (ESSENTIALS-368)

      Attachments

        Activity

          People

            Unassigned Unassigned
            tjeger Tobias Jeger
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: