Uploaded image for project: 'Hippo CMS'
  1. Hippo CMS
  2. CMS-15634

Contextual documentation links for document types and components

    XMLWordPrintable

Details

    • Epic
    • Status: Closed
    • Normal
    • Resolution: Fixed
    • None
    • 15.5.0, 16.0.0
    • None
    • None
    • Contextual Documentation Links
    • Orion
    • Done
    • Undetermined

    Description

      One Pager: https://docs.google.com/document/d/1N2wBBKR__EQFc1Hiqw6qZa-628No5KfLcorGxfy2uMo/edit

      Limited guidance and documentation in the product result in a suboptimal content authoring experience for users when they are not able to complete a task in the CMS.

      Currently there is only one place where customers can set a documentation link in the help menu. These links are general for BrXM and customer’s own documentation.

      General links are helpful but users still need to find the related content in the documentation site which is time consuming.

      When users are looking for help, they would like to refer to the related documentation and specifically to their own custom documentation if there is any.

      From time to time, customers create their own documentation for document types and components to guide editors and authors how to use them and help when they are stuck during authoring in the CMS. We are proposing meta-data in document type and component that can keep specific links to related documentation. Links can be added by developers on console or document type editor(only for document types). This meta-data should be presented clickable by editors and authors so that they can open the link but they should be read only in the component properties and documents so editors and authors cannot change it. These links should be available in both experience manager and content perspective.

      User Stories

      Document types:

      • As a developer, I would like to set custom documentation links for document types in the console so that editors and authors can refer to these links when they need help. 
      • As an editor/author, I’d like to see the specific documentation links in the component properties as read only meta-data so that I can refer to related documentation while I’m authoring

       

      Components

      • As a developer, I would like to set custom documentation links for components in component properties through console so that editors and authors can refer to these links when they need help
      • As an editor/author, I’d like to see the specific documentation links in the component properties as read only meta-data so that I can refer to related documentation while I’m authoring

       

       

      Attachments

        Activity

          People

            Unassigned Unassigned
            deniz.ergun Deniz Ergun
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: