Skip to content

Commit d27bffc

Browse files
committed
fix migration docs
1 parent f14a09f commit d27bffc

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

docs/content/doc/advanced/migrations.en-us.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,21 @@ menu:
1515

1616
# Migration Features
1717

18-
The new migration features introduced in Gitea 1.9.0. It defined two interfaces to support migrating
19-
repositories data from other git host platforms to gitea or in future migrating gitea data to other
20-
git host platform. Currently, it only implements to migrate from github via APIv3 to Gitea.
18+
The new migration features were introduced in Gitea 1.9.0. It defines two interfaces to support migrating
19+
repositories data from other git host platforms to gitea or, in the future migrating gitea data to other
20+
git host platforms. Currently, only the migrations from github via APIv3 to Gitea is implemented.
2121

22-
First of all, Gitea defines some standard objects, `Repository`, `Milestone`, `Release`, `Label`, `Issue`,
23-
`Comment`, `PullRequest`.
22+
First of all, Gitea defines some standard objects in packages `modules/migrations/base`. They are
23+
`Repository`, `Milestone`, `Release`, `Label`, `Issue`, `Comment`, `PullRequest`.
2424

2525
## Downloader Interfaces
2626

2727
To migrate from a new git host platform, there are two steps to be updated.
2828

29-
- You should implement a Downloader which could get repository all kinds of informations.
30-
- You should implement a DownloaderFactory which could detect if the url should match the
31-
factory and new a Downloader
32-
- You should RegisterDownloaderFactory when init
29+
- You should implement a `Downloader` which will get all kinds of repository informations.
30+
- You should implement a `DownloaderFactory` which is used to detect if the URL matches and
31+
create a Downloader.
32+
- You'll need to register the `DownloaderFactory` via `RegisterDownloaderFactory` on init.
3333

3434
```Go
3535
type Downloader interface {
@@ -52,8 +52,9 @@ type DownloaderFactory interface {
5252

5353
## Uploader Interface
5454

55-
Currently, we only implemented an Uploader `GiteaLocalUploader` so we only save downloaded
56-
data via this `Uploader` and we haven't supported a new Uploader that will be in future.
55+
Currently, only a `GiteaLocalUploader` is implemented, so we only save downloaded
56+
data via this `Uploader` on the local Gitea instance. Other uploaders are not supported
57+
and will be implemented in future.
5758

5859
```Go
5960
// Uploader uploads all the informations

0 commit comments

Comments
 (0)