Uploaded image for project: 'PUBLIC - Liferay Documentation'
  1. PUBLIC - Liferay Documentation
  2. LRDOCS-7132

Suggestion to improve development tutorials

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Fix Version/s: 7.0.x
    • Component/s: None
    • Labels:
      None
    • Type of Documentation:
      Developer: Tutorials

      Description

      Per Tibor Jandi from LRSUPPORT-32989:

      There are some (or more) tutorials that aren't clear enough, hard to follow and hard to reach the end goal. For example: https://help.liferay.com/hc/en-us/articles/360017881272-Implementing-Application-Display-Templates

      I spent an hour to create a proof of concept based on this article, however the portlet doesn't work so far and I'll need to spend more extra hours to make it work.
      That's how the idea came to my mind:

      When a developer creates such technical documentation, most probably they create the test module as well to make sure what he documents works.
      **

      My suggestion is to attach the project source and the deployable module to the documentation for the future releases. (I would like to have it for 7.1 as well, however I have a feeling that it's too much extra work).

      Pros:
      As the project is created during documenting, there is no extra work.
      The customers will have a good working example, and it lowers the chance to do mistakes during customization.
      Support doesn't have to create proof of concepts anymore as it will be attached to the implementation.

      Looking forward to your response,
      Tibor

        Attachments

          Activity

            People

            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:

                Packages

                Version Package
                7.0.x