diff options
| author | Evan Read <eread@gitlab.com> | 2018-11-13 09:07:16 +0300 |
|---|---|---|
| committer | Evan Read <eread@gitlab.com> | 2019-01-08 05:21:09 +0300 |
| commit | d98560c1f5c54127d1a48c4c8e326bbf06c31c4b (patch) | |
| tree | b2d2fc26829e0a7b25da18d09a1e7e07ba1efed8 /doc/development/github_importer.md | |
| parent | 710f2ec50c49d1e773acc20058ed584f1402de33 (diff) | |
Make unordered lists conform to styleguide
- Also makes other minor Markdown fixes that were near the main fixes.
Diffstat (limited to 'doc/development/github_importer.md')
| -rw-r--r-- | doc/development/github_importer.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/development/github_importer.md b/doc/development/github_importer.md index 863ac049db6..5445f36b9fa 100644 --- a/doc/development/github_importer.md +++ b/doc/development/github_importer.md @@ -13,20 +13,20 @@ or Rake tasks. The parallel importer on the other hand uses Sidekiq. ## Requirements -* GitLab CE 10.2.0 or newer. -* Sidekiq workers that process the `github_importer` and +- GitLab CE 10.2.0 or newer. +- Sidekiq workers that process the `github_importer` and `github_importer_advance_stage` queues (this is enabled by default). -* Octokit (used for interacting with the GitHub API) +- Octokit (used for interacting with the GitHub API). ## Code structure The importer's codebase is broken up into the following directories: -* `lib/gitlab/github_import`: this directory contains most of the code such as +- `lib/gitlab/github_import`: this directory contains most of the code such as the classes used for importing resources. -* `app/workers/gitlab/github_import`: this directory contains the Sidekiq +- `app/workers/gitlab/github_import`: this directory contains the Sidekiq workers. -* `app/workers/concerns/gitlab/github_import`: this directory contains a few +- `app/workers/concerns/gitlab/github_import`: this directory contains a few modules reused by the various Sidekiq workers. ## Architecture overview @@ -188,8 +188,8 @@ projects get imported the fewer GitHub API calls will be needed. The code for this resides in: -* `lib/gitlab/github_import/user_finder.rb` -* `lib/gitlab/github_import/caching.rb` +- `lib/gitlab/github_import/user_finder.rb` +- `lib/gitlab/github_import/caching.rb` ## Mapping labels and milestones @@ -204,6 +204,6 @@ project that is being imported. The code for this resides in: -* `lib/gitlab/github_import/label_finder.rb` -* `lib/gitlab/github_import/milestone_finder.rb` -* `lib/gitlab/github_import/caching.rb` +- `lib/gitlab/github_import/label_finder.rb` +- `lib/gitlab/github_import/milestone_finder.rb` +- `lib/gitlab/github_import/caching.rb` |