Uploaded image for project: 'Managed Service - Streams'
  1. Managed Service - Streams
  2. MGDSTRM-9610

[ideate] accessing sample code for Java and Python clients

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Undefined Undefined
    • None
    • None
    • None
    • False
    • None
    • False
    • No
    • MGDSRVS-366 - RHOSAK Usability Improvements
    • ---
    • ---

      WHAT

      When I have a Kafka instance, I want access to configuration snippets that I can use in a Java or Python client, so that I can copy one chunk of code that has connection details already formatted for that client. 

      WHY

      Providing code snippets with connection details already included streamlines the user's ability to get started with using our service.

      HOW

      • From the context of the Kafka UI we have today, provide designs that illustrate how a user can:
        • access configuration snippets for the following supported clients per Kafka instance:
          • Java
          • Python
          • Quarkus
          • Spring Boot
        • copy configuration snippets
      • Use PF components as implemented as much as possible.
        • If PF components don't support our use case, identify where the gap is

      Additional resources:

      When RH first started collaborating with IBM on a common UI for strimzi, we started from a set of designs that they had created. There is an example in their prototype that shows how this sample code could be surfaced adjacent to connection information: https://ibm.invisionapp.com/share/8PNZRRH9EXA#/screens/319451035

      The first set of PF mockups were based on this prototype. But at the time, the requirements for the configuration samples were not clearly defined, and the design we implemented for the service has changed since these original PF mockups. This is the original PF mockup showing how configuration samples could be included, but it's really outdated: 
      https://www.sketch.com/s/ac7c9594-ad7e-4d61-9b1c-047d2a2dbf1f/a/zDLxwa

      DONE

      Include the following where applicable:

      • Designs are shared with other UX designers 
      • Designs are reviewed with PM and UI dev
      • Feedback from review has been addressed

              tma@redhat.com April Ma
              jgiardin Jennifer Giardino
              MK - Consoles
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

                Created:
                Updated:
                Resolved: