Refactor docs (#13275)
* First pass Signed-off-by: jolheiser <john.olheiser@gmail.com> * More changes Signed-off-by: jolheiser <john.olheiser@gmail.com> * Redirects Signed-off-by: jolheiser <john.olheiser@gmail.com>tokarchuk/v1.17
John Olheiser
4 years ago
committed by
GitHub
parent
bfc553164a
commit
1d6b565de4
@ -1,37 +0,0 @@ |
||||
--- |
||||
date: "2019-08-27:00:00+02:00" |
||||
title: "CI/CD Usage" |
||||
slug: "ci-cd" |
||||
weight: 40 |
||||
toc: true |
||||
draft: false |
||||
menu: |
||||
sidebar: |
||||
parent: "advanced" |
||||
name: "CI/CD Usage" |
||||
weight: 40 |
||||
identifier: "ci-cd" |
||||
--- |
||||
|
||||
# Gitea and CI/CD |
||||
**NOTE:** These tools are not endorsed by Gitea. They are listed here for convenience only. |
||||
|
||||
## Hey! This page may be out of date or even removed in the future! :scream: |
||||
Instead, check out [awesome-gitea](https://gitea.com/gitea/awesome-gitea/src/branch/master/README.md#user-content-devops)! |
||||
|
||||
## Listing |
||||
|
||||
CI/CD solutions that have integration with Gitea. Following list is not complete, |
||||
the purpose is to give a starting point to integrate a CI/CD process with your Gitea instance. |
||||
|
||||
- [Drone](https://drone.io) with [Gitea documentation](https://docs.drone.io/installation/providers/gitea/) |
||||
- [Jenkins](https://jenkins.io/) with [Gitea plugin](https://plugins.jenkins.io/gitea) |
||||
- [Agola](https://agola.io) |
||||
- [Buildkite](https://buildkite.com) with [Gitea connector](https://github.com/techknowlogick/gitea-buildkite-connector) |
||||
- [AppVeyor](https://www.appveyor.com) with [built-in Gitea support](https://www.appveyor.com/blog/2019/09/05/gitea-receives-first-class-support-in-appveyor/) |
||||
- [Buildbot](https://www.buildbot.net/) with [Gitea plugin](https://github.com/lab132/buildbot-gitea) |
||||
|
||||
|
||||
Others CI/CD solutions that can partially be integrated with Gitea: |
||||
|
||||
- [Concourse](https://www.concourse-ci.org), see more information at [Concourse community forum](https://discuss.concourse-ci.org/t/concourse-ci-and-gitea-oauth/1475) |
||||
@ -1,19 +1,19 @@ |
||||
--- |
||||
date: "2017-04-08T11:34:00+02:00" |
||||
title: "Specific variables" |
||||
slug: "specific-variables" |
||||
title: "Environment variables" |
||||
slug: "environment-variables" |
||||
weight: 20 |
||||
toc: false |
||||
draft: false |
||||
menu: |
||||
sidebar: |
||||
parent: "advanced" |
||||
name: "Specific variables" |
||||
name: "Environment variables" |
||||
weight: 20 |
||||
identifier: "specific-variables" |
||||
identifier: "environment-variables" |
||||
--- |
||||
|
||||
# Specific variables |
||||
# Environment variables |
||||
|
||||
This is an inventory of Gitea environment variables. They change Gitea behaviour. |
||||
|
||||
@ -1,46 +0,0 @@ |
||||
--- |
||||
date: "2017-01-14T11:00:00-02:00" |
||||
title: "Make" |
||||
slug: "make" |
||||
weight: 10 |
||||
toc: true |
||||
draft: false |
||||
menu: |
||||
sidebar: |
||||
parent: "advanced" |
||||
name: "Make" |
||||
weight: 30 |
||||
identifier: "make" |
||||
--- |
||||
|
||||
# Make |
||||
|
||||
Gitea makes heavy use of Make to automate tasks and improve development. This |
||||
guide covers how to install Make. |
||||
|
||||
### On Linux |
||||
|
||||
Install with the package manager. |
||||
|
||||
On Ubuntu/Debian: |
||||
|
||||
```bash |
||||
sudo apt-get install make |
||||
``` |
||||
|
||||
On Fedora/RHEL/CentOS: |
||||
|
||||
```bash |
||||
sudo yum install make |
||||
``` |
||||
|
||||
### On Windows |
||||
|
||||
One of these three distributions of Make will run on Windows: |
||||
|
||||
- [Single binary build](http://www.equation.com/servlet/equation.cmd?fa=make). Copy somewhere and add to `PATH`. |
||||
- [32-bits version](ftp://ftp.equation.com/make/32/make.exe) |
||||
- [64-bits version](ftp://ftp.equation.com/make/64/make.exe) |
||||
- [MinGW](http://www.mingw.org/) includes a build. |
||||
- The binary is called `mingw32-make.exe` instead of `make.exe`. Add the `bin` folder to `PATH`. |
||||
- [Chocolatey package](https://chocolatey.org/packages/make). Run `choco install make` |
||||
@ -1,81 +0,0 @@ |
||||
--- |
||||
date: "2019-04-15T17:29:00+08:00" |
||||
title: "Advanced: Migrations Interfaces" |
||||
slug: "migrations-interfaces" |
||||
weight: 30 |
||||
toc: true |
||||
draft: false |
||||
menu: |
||||
sidebar: |
||||
parent: "advanced" |
||||
name: "Migrations Interfaces" |
||||
weight: 55 |
||||
identifier: "migrations-interfaces" |
||||
--- |
||||
|
||||
# Migration Features |
||||
|
||||
The new migration features were introduced in Gitea 1.9.0. It defines two interfaces to support migrating |
||||
repositories data from other git host platforms to gitea or, in the future migrating gitea data to other |
||||
git host platforms. Currently, migrations from Github, Gitlab and Gitea to Gitea is implemented. |
||||
|
||||
First of all, Gitea defines some standard objects in packages `modules/migrations/base`. They are |
||||
`Repository`, `Milestone`, `Release`, `ReleaseAsset`, `Label`, `Issue`, `Comment`, `PullRequest`, `Reaction`, `Review`, `ReviewComment`. |
||||
|
||||
## Downloader Interfaces |
||||
|
||||
To migrate from a new git host platform, there are two steps to be updated. |
||||
|
||||
- You should implement a `Downloader` which will get all kinds of repository informations. |
||||
- You should implement a `DownloaderFactory` which is used to detect if the URL matches and |
||||
create a Downloader. |
||||
- You'll need to register the `DownloaderFactory` via `RegisterDownloaderFactory` on init. |
||||
|
||||
```Go |
||||
type Downloader interface { |
||||
GetAsset(relTag string, relID, id int64) (io.ReadCloser, error) |
||||
SetContext(context.Context) |
||||
GetRepoInfo() (*Repository, error) |
||||
GetTopics() ([]string, error) |
||||
GetMilestones() ([]*Milestone, error) |
||||
GetReleases() ([]*Release, error) |
||||
GetLabels() ([]*Label, error) |
||||
GetIssues(page, perPage int) ([]*Issue, bool, error) |
||||
GetComments(issueNumber int64) ([]*Comment, error) |
||||
GetPullRequests(page, perPage int) ([]*PullRequest, bool, error) |
||||
GetReviews(pullRequestNumber int64) ([]*Review, error) |
||||
} |
||||
``` |
||||
|
||||
```Go |
||||
type DownloaderFactory interface { |
||||
New(ctx context.Context, opts MigrateOptions) (Downloader, error) |
||||
GitServiceType() structs.GitServiceType |
||||
} |
||||
``` |
||||
|
||||
## Uploader Interface |
||||
|
||||
Currently, only a `GiteaLocalUploader` is implemented, so we only save downloaded |
||||
data via this `Uploader` on the local Gitea instance. Other uploaders are not supported |
||||
and will be implemented in future. |
||||
|
||||
```Go |
||||
// Uploader uploads all the informations |
||||
type Uploader interface { |
||||
MaxBatchInsertSize(tp string) int |
||||
CreateRepo(repo *Repository, opts MigrateOptions) error |
||||
CreateTopics(topic ...string) error |
||||
CreateMilestones(milestones ...*Milestone) error |
||||
CreateReleases(downloader Downloader, releases ...*Release) error |
||||
SyncTags() error |
||||
CreateLabels(labels ...*Label) error |
||||
CreateIssues(issues ...*Issue) error |
||||
CreateComments(comments ...*Comment) error |
||||
CreatePullRequests(prs ...*PullRequest) error |
||||
CreateReviews(reviews ...*Review) error |
||||
Rollback() error |
||||
Close() |
||||
} |
||||
|
||||
``` |
||||
@ -1,43 +0,0 @@ |
||||
--- |
||||
date: "2018-05-22T11:00:00+00:00" |
||||
title: "Advanced: Third Party Tools" |
||||
slug: "third-party-tools" |
||||
weight: 50 |
||||
toc: true |
||||
draft: false |
||||
menu: |
||||
sidebar: |
||||
parent: "advanced" |
||||
name: "Third Party Tools" |
||||
weight: 50 |
||||
identifier: "third-party-tools" |
||||
--- |
||||
|
||||
# List of third-party tools |
||||
**NOTE:** These tools are not endorsed by Gitea. They are listed here for convenience only. |
||||
|
||||
## Hey! This page may be out of date or even removed in the future! :scream: |
||||
Instead, check out [awesome-gitea](https://gitea.com/gitea/awesome-gitea/src/branch/master/README.md)! |
||||
|
||||
### Continuous Integration |
||||
|
||||
Check our [CI/CD page]({{< relref "doc/advanced/ci-cd.en-us.md" >}}) |
||||
|
||||
### Internationalization |
||||
- [Weblate](https://docs.weblate.org/en/latest/admin/continuous.html#gitea-setup) |
||||
|
||||
### Migrating |
||||
- [Installation script for Gitea](https://git.coolaj86.com/coolaj86/gitea-installer.sh) |
||||
- [GitHub Migrator](https://gitea.com/gitea/migrator) |
||||
|
||||
|
||||
### Mobile |
||||
- [GitNex for Android](https://codeberg.org/gitnex/GitNex) |
||||
- [GitTouch for Android and iOS](https://github.com/git-touch/git-touch) |
||||
|
||||
### Editor Extensions |
||||
- [Gitea Extension for Visual Studio](https://github.com/maikebing/Gitea.VisualStudio) |
||||
- Download from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=MysticBoy.GiteaExtensionforVisualStudio) |
||||
|
||||
### Project Management |
||||
- [YouTrack by JetBrains](https://blog.jetbrains.com/youtrack/2019/12/whats-new-in-youtrack-2019-3/) |
||||
@ -0,0 +1,13 @@ |
||||
--- |
||||
date: "2016-12-01T16:00:00+02:00" |
||||
title: "Developers" |
||||
slug: "developers" |
||||
weight: 40 |
||||
toc: false |
||||
draft: false |
||||
menu: |
||||
sidebar: |
||||
name: "Developers" |
||||
weight: 50 |
||||
identifier: "developers" |
||||
--- |
||||
@ -0,0 +1,26 @@ |
||||
--- |
||||
date: "2019-04-15T17:29:00+08:00" |
||||
title: "Integrations" |
||||
slug: "integrations" |
||||
weight: 40 |
||||
toc: true |
||||
draft: false |
||||
menu: |
||||
sidebar: |
||||
parent: "developers" |
||||
name: "Integrations" |
||||
weight: 65 |
||||
identifier: "integrations" |
||||
--- |
||||
|
||||
# Integrations |
||||
|
||||
Gitea has a wonderful community of third-party integrations, as well as first-class support in various other |
||||
projects. |
||||
|
||||
We are curating a list over at [awesome-gitea](https://gitea.com/gitea/awesome-gitea) to track these! |
||||
|
||||
If you are looking for [CI/CD](https://gitea.com/gitea/awesome-gitea#devops), |
||||
an [SDK](https://gitea.com/gitea/awesome-gitea#sdk), |
||||
or even some extra [themes](https://gitea.com/gitea/awesome-gitea#themes), |
||||
you can find them listed in the [awesome-gitea](https://gitea.com/gitea/awesome-gitea) repository! |
||||
@ -0,0 +1,41 @@ |
||||
--- |
||||
date: "2019-04-15T17:29:00+08:00" |
||||
title: "Migrations Interfaces" |
||||
slug: "migrations-interfaces" |
||||
weight: 30 |
||||
toc: true |
||||
draft: false |
||||
menu: |
||||
sidebar: |
||||
parent: "developers" |
||||
name: "Migrations Interfaces" |
||||
weight: 55 |
||||
identifier: "migrations-interfaces" |
||||
--- |
||||
|
||||
# Migration Features |
||||
|
||||
Complete migrations were introduced in Gitea 1.9.0. It defines two interfaces to support migrating |
||||
repository data from other git host platforms to Gitea or, in the future, migrating Gitea data to other |
||||
git host platforms. |
||||
Currently, migrations from Github, Gitlab, and other Gitea instances are implemented. |
||||
|
||||
First of all, Gitea defines some standard objects in packages [modules/migrations/base](https://github.com/go-gitea/gitea/tree/master/modules/migrations/base). |
||||
They are `Repository`, `Milestone`, `Release`, `ReleaseAsset`, `Label`, `Issue`, `Comment`, `PullRequest`, `Reaction`, `Review`, `ReviewComment`. |
||||
|
||||
## Downloader Interfaces |
||||
|
||||
To migrate from a new git host platform, there are two steps to be updated. |
||||
|
||||
- You should implement a `Downloader` which will be used to get repository information. |
||||
- You should implement a `DownloaderFactory` which will be used to detect if the URL matches and create the above `Downloader`. |
||||
- You'll need to register the `DownloaderFactory` via `RegisterDownloaderFactory` on `init()`. |
||||
|
||||
You can find these interfaces in [downloader.go](https://github.com/go-gitea/gitea/blob/master/modules/migrations/base/downloader.go). |
||||
|
||||
## Uploader Interface |
||||
|
||||
Currently, only a `GiteaLocalUploader` is implemented, so we only save downloaded |
||||
data via this `Uploader` to the local Gitea instance. Other uploaders are not supported at this time. |
||||
|
||||
You can find these interfaces in [uploader.go](https://github.com/go-gitea/gitea/blob/master/modules/migrations/base/uploader.go). |
||||
Loading…
Reference in new issue