Commit 7bd83c1b authored by Nick Gaskill's avatar Nick Gaskill

Merge branch 'kassio/github-importer-add-missing-docs' into 'master'

GithubImporter: Add missing docs about some recent added stages

See merge request gitlab-org/gitlab!66733
parents 1cc201fd 07097b68
......@@ -69,7 +69,23 @@ don't need to perform this work in parallel.
This worker imports all pull requests. For every pull request a job for the
`Gitlab::GithubImport::ImportPullRequestWorker` worker is scheduled.
### 5. Stage::ImportIssuesAndDiffNotesWorker
### 5. Stage::ImportPullRequestsMergedByWorker
This worker imports the pull requests' _merged-by_ user information. The [_List pull
requests_](https://docs.github.com/en/rest/reference/pulls#list-pull-requests)
API doesn't provide this information. Therefore, this stage must fetch each merged pull request
individually to import this information. A
`Gitlab::GithubImport::ImportPullRequestMergedByWorker` job is scheduled for each fetched pull
request.
### 6. Stage::ImportPullRequestsReviewsWorker
This worker imports the pull requests' reviews. For each pull request, this worker:
- Fetches all the pages of reviews.
- Schedules a `Gitlab::GithubImport::ImportPullRequestReviewWorker` job for each fetched review.
### 7. Stage::ImportIssuesAndDiffNotesWorker
This worker imports all issues and pull request comments. For every issue, we
schedule a job for the `Gitlab::GithubImport::ImportIssueWorker` worker. For
......@@ -85,7 +101,7 @@ label links in the same worker removes the need for performing a separate crawl
through the API data, reducing the number of API calls necessary to import a
project.
### 6. Stage::ImportNotesWorker
### 8. Stage::ImportNotesWorker
This worker imports regular comments for both issues and pull requests. For
every comment, we schedule a job for the
......@@ -96,7 +112,7 @@ returns comments for both issues and pull requests. This means we have to wait
for all issues and pull requests to be imported before we can import regular
comments.
### 7. Stage::FinishImportWorker
### 9. Stage::FinishImportWorker
This worker completes the import process by performing some housekeeping
(such as flushing any caches) and by marking the import as completed.
......
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