Uploaded image for project: 'PUBLIC - Liferay Commerce'
  1. PUBLIC - Liferay Commerce
  2. COMMERCE-4682

Create internal documentation for the Dispatch

    Details

    • Type: Documentation
    • Status: Awaiting Draft
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: DI GA2
    • Component/s: Data Integration
    • Labels:
      None

      Description

      Background

      We need to create internal documentation so

      1. Knowledge management can create customer-facing documentation and our customers can know how to use the data integration admin (LRDOCS-8072)
      2. The USM team, which will be taking ownership of the future development and maintenance of the data integration admin, needs documentation on how the feature is intended to work so they can successfully maintain it.

      We cannot fully give support liability to a different team until after the documentation exists.

      Definition of Done

      1. Internal documentation
        1. User doc info: how to use the data integration manager to schedule and run jobs as a sys admin
          1. Custom Talend jobs
          2. Salesforce Sync jobs
          3. Recommenders
        2. TS doc info: how the feature is built and pointers on how to debug

      What we're not doing

      Don't worry about polished, customer-facing documentation. The knowledge management team can take care of that. We can provide sparse documentation or even outlines.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              matija.petanjek Matija Petanjek
              Reporter:
              corbin.murakami Corbin Murakami
              Participants of an Issue:
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:

                  Packages

                  Version Package
                  DI GA2