Document a conceptual object model for Jobs
Problem
Jobs are the main building block of a pipeline. Understanding the essence of Jobs and the concepts associated with them can help us create a better experience around Jobs in GitLab UI. Currently, Jobs are not documented as an object in GitLab. It's difficult to find information around all the concepts associated with jobs and how they're represented in the UI.
Proposal
Document Jobs using the Conceptual Object Model.
This model allows for proper separation of concerns: concepts (meaning) and user interface (representation). In other words, a conceptual model is only focused on the concepts and how they relate to each other, not how it’s technically implemented or used in the UI. A conceptual model defines the objects and actions, and enumerates the attributes for every object. The language of the conceptual model diagram is meant to be as simple and accessible as possible to everyone, even if they are not familiar with these kinds of diagrams (for more information, see Object Modeling for Designers.
Here's an example of how we document the Merge Request as an object in GitLab.
Next steps
-
Document the concepts associated with Jobs -
Map the concepts associated with Jobs -
Document the layouts for the representations of Jobs in GitLab -
Review the Figma file -
Merge to the Conceptual object model file in Figma -
Map the primary Job page layout -
Merge the semantic layout to the Layouts file -
Work on a documentation MR (MR in review)