Technical diagrams for Cancel/Expire Flow
Parent Epic: GitLab.com <> Customers, License, Zuora Integration
Epic: [ENG] Document all flows between GitLab.com <> Customers, License, Zuora
--
Overview
Before we can fix the GitLab.com <> Customers, License, Zuora Integration, we first need to better understand all of the user flows from a technical perspective.
UX is also documenting all of these flows using mural diagrams. The purpose of the technical documentation is to make it easier to understand the different interactions between each application as a user goes through each purchase / signup flow.
Requirements
- Each flow should have a sequence diagram. Example template provided here. This documentation can be added to the Customer app's /doc folder.
- Each endpoint should have API documentation. Example of API documentation which includes list of endpoints, table of attributes, example request, example response. Customers API documentation can be added to the Customer app's /doc folder.
- Each database should have an ERD (Entity Relationship Diagram). We should specifically note the reference columns used to join tables across the applications. Each ERD can be added to each project's readme. The ERD showing the linking across GitLab <> Customers can be added to the Customer app's /doc folder.
Flows
From List of Flows:
Cancel / Expire Flow
- Web Direct/SaaS - Cancel
-
Starting on Customers -
Starting on GitLab.com
-
- Self-managed - Cancel
-
Starting on Customers -
Starting on GitLab
-
Edited by Jerome Z Ng