Uploaded image for project: 'Red Hat 3scale API Management'
  1. Red Hat 3scale API Management
  2. THREESCALE-6514

Modularization workshop review of Admin Portal Guide: Designating methods and adding metrics for capturing usage details

    XMLWordPrintable

Details

    • Task
    • Resolution: Obsolete
    • Major
    • None
    • None
    • Documentation
    • False
    • False
    • Not Started
    • Not Started
    • Not Started
    • Not Started
    • Not Started
    • Not Started
    • Undefined

    Description

      Summary of outcomes

      • Prerequisites can be added at assembly level, however, ideally modules should stand on their own and therefore have their own prerequisites.
      • Heading should be goal focused, however 3scale heading sometimes include details from the product UI.
      • Possibly add product name to headings.
      • Abstract should contain product/feature name/user story information.
      • Additional resources should contain links only. No additional text. (milestone 3 of PV2 modularization)
      • General information in assembly can be a concept module.
      • Long paragraphs can be bullet lists.
      • Short reference module can be included somewhere else as additional resources for example.

      Resources

      Modularization workshop review comments: https://docs.google.com/document/d/1ZLlFQsRzXgoYmhX2RHGIXnAWP3oe6iXb2KQwLS7zDSU/edit

      Modularization workshop notes: https://docs.google.com/document/d/1NjJBO772xGhtHSqjvybIns2RvShu8gFuC-X-gVefLXQ/edit#heading=h.poskjb0ya02

      Official Pv2 MS3 migration checklists: https://docs.engineering.redhat.com/display/~lvaleeva/Pv2+MS3+migration+checklists

      IBM Styleguide quick reference: https://docs.engineering.redhat.com/display/CCSENABLE/IBM+Style+Guide%3A+quick+reference

      Attachments

        Activity

          People

            Unassigned Unassigned
            dfenness@redhat.com Darren Fennessy
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: