Skip to content

Add class documentation for the bulk import models

Josianne Hyson requested to merge jh-bulk_import_docs into master

🌳 What does this MR do?

Following up from a discussion (!42978 (comment 429448364)) where the BulkImport* models were created. We found that the intended structure of these models is not super obvious just from reading this code.

Add some class documentation to these models so that anyone new to the domain can more easily understand the intention behind them.

Eventually, as this feature develops, we can also add contribution guides to our main docs which includes the high level architecture.

🔍 Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • ~~Label as security and @ mention @gitlab-com/gl-security/appsec~~
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team
Edited by Josianne Hyson

Merge request reports

Loading