Commit 72b583ef authored by Mike Jang's avatar Mike Jang Committed by Robert Speicher

Docs Post-Merge review "Add class doc for bulk import models"

parent 1b4c644d
# frozen_string_literal: true # frozen_string_literal: true
# The BulkImport import model links together all the models required to for a # The BulkImport model links all models required for a bulk import of groups and
# bulk import of groups and projects to a GitLab instance, and associates these # projects to a GitLab instance. It associates the import with the responsible
# with the user that initiated the import. # user.
class BulkImport < ApplicationRecord class BulkImport < ApplicationRecord
belongs_to :user, optional: false belongs_to :user, optional: false
......
# frozen_string_literal: true # frozen_string_literal: true
# The BulkImport::Entity represents a Group or Project that is going to be # The BulkImport::Entity represents a Group or Project to be imported during the
# imported during the bulk import process. An entity is nested under the a # bulk import process. An entity is nested under the parent group when it is not
# parent group when it is not a top level group. # a top level group.
# #
# A full bulk import entity structure might look like this, where the links are # A full bulk import entity structure might look like this, where the links are
# parents: # parents:
...@@ -15,8 +15,8 @@ ...@@ -15,8 +15,8 @@
# | | # | |
# ProjectEntity Project # ProjectEntity Project
# #
# The tree structure of the entities will result in the same structure for the # The tree structure of the entities results in the same structure for imported
# imported Groups and Projects. # Groups and Projects.
class BulkImports::Entity < ApplicationRecord class BulkImports::Entity < ApplicationRecord
self.table_name = 'bulk_import_entities' self.table_name = 'bulk_import_entities'
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment