Update meta data of docs

This commit is contained in:
Lunny Xiao
2024-08-06 16:44:42 -07:00
parent 4917bd18ae
commit af22422e1a
861 changed files with 1383 additions and 7148 deletions

View File

@@ -3,8 +3,7 @@ date: "2016-12-01T16:00:00+02:00"
title: "Administration"
slug: "administration"
sidebar_position: 30
toc: false
draft: false
menu:
sidebar:
name: "Administration"

View File

@@ -1,13 +1,12 @@
---
date: "2018-05-11T11:00:00+02:00"
title: "Fail2ban Setup "
slug: "fail2ban-setup"
sidebar_position: 16
aliases:
- /en-us/fail2ban-setup
---
# Fail2ban setup to block users after failed login attempts
# Fail2ban Setup
**Remember that fail2ban is powerful and can cause lots of issues if you do it incorrectly, so make
sure to test this before relying on it so you don't lock yourself out.**

View File

@@ -1,13 +1,12 @@
---
date: "2019-10-06T08:00:00+05:00"
title: "Git LFS setup"
slug: "git-lfs-setup"
sidebar_position: 12
aliases:
- /en-us/git-lfs-setup
---
# Git Large File Storage setup
# Git LFS setup
To use Gitea's built-in LFS support, you must update the `app.ini` file:

View File

@@ -1,13 +1,12 @@
---
date: "2018-06-02T11:00:00+02:00"
title: "HTTPS setup"
slug: "https-setup"
sidebar_position: 12
aliases:
- /en-us/https-setup
---
# HTTPS setup to encrypt connections to Gitea
# HTTPS Setup
## Using the built-in server

View File

@@ -1,6 +1,5 @@
---
date: "2019-04-02T17:06:00+01:00"
title: "Logging Configuration"
slug: "logging-config"
sidebar_position: 40
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2019-10-23T17:00:00-03:00"
title: "Mail templates"
slug: "mail-templates"
sidebar_position: 45
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2019-09-06T01:35:00-03:00"
title: "Repository indexer"
slug: "repo-indexer"
sidebar_position: 45
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2018-05-22T11:00:00+00:00"
title: "Reverse Proxies"
slug: "reverse-proxies"
sidebar_position: 16
aliases:

View File

@@ -1,13 +1,12 @@
---
date: "2019-12-31T13:55:00+05:00"
title: "Search Engines Indexation"
slug: "search-engines-indexation"
sidebar_position: 60
aliases:
- /en-us/search-engines-indexation
---
# Search engines indexation of your Gitea installation
# Search Engines Indexation
By default your Gitea installation will be indexed by search engines.
If you don't want your repository to be visible for search engines read further.

View File

@@ -1,6 +1,5 @@
---
date: "2019-08-17T10:20:00+01:00"
title: "GPG Commit Signatures"
slug: "signing"
sidebar_position: 50
aliases:

View File

@@ -3,8 +3,7 @@ date: "2021-01-22T00:00:00+02:00"
title: "Contributing"
slug: "contributing"
sidebar_position: 35
toc: false
draft: false
menu:
sidebar:
name: "Contributing"

View File

@@ -1,6 +1,5 @@
---
date: "2021-11-01T23:41:00+08:00"
title: "Guidelines for Backend Development"
slug: "guidelines-backend"
sidebar_position: 20
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2023-02-14T00:00:00+00:00"
title: "Guidelines for Refactoring"
slug: "guidelines-refactoring"
sidebar_position: 40
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2016-12-01T16:00:00+02:00"
title: "Localization"
slug: "localization"
sidebar_position: 70
aliases:

View File

@@ -3,8 +3,7 @@ date: "2016-12-01T16:00:00+02:00"
title: "Development"
slug: "development"
sidebar_position: 40
toc: false
draft: false
menu:
sidebar:
name: "Development"

View File

@@ -1,6 +1,5 @@
---
date: "2018-06-24:00:00+02:00"
title: "API Usage"
slug: "api-usage"
sidebar_position: 40
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2016-12-01T16:00:00+02:00"
title: "Hacking on Gitea"
slug: "hacking-on-gitea"
sidebar_position: 10
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2019-04-15T17:29:00+08:00"
title: "Integrations"
slug: "integrations"
sidebar_position: 65
aliases:

View File

@@ -1,13 +1,12 @@
---
date: "2019-04-15T17:29:00+08:00"
title: "Migrations Interfaces"
slug: "migrations-interfaces"
sidebar_position: 55
aliases:
- /en-us/migrations-interfaces
---
# Migration Features
# Migration Interfaces
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.

View File

@@ -1,13 +1,12 @@
---
date: "2023-06-01T08:40:00+08:00"
title: "OAuth2 provider"
slug: "oauth2-provider"
sidebar_position: 41
aliases:
- /en-us/oauth2-provider
---
# OAuth2 provider
# OAuth2 Provider
Gitea supports acting as an OAuth2 provider to allow third party applications to access its resources with the user's consent. This feature is available since release 1.8.0.

View File

@@ -3,8 +3,7 @@ date: "2017-01-20T15:00:00+08:00"
title: "Help"
slug: "help"
sidebar_position: 5
toc: false
draft: false
menu:
sidebar:
name: "Help"

View File

@@ -1,13 +1,12 @@
---
date: "2019-04-05T16:00:00+02:00"
title: "FAQ"
slug: "faq"
sidebar_position: 5
aliases:
- /en-us/faq
---
# Frequently Asked Questions
# FAQ
This page contains some common questions and answers.

View File

@@ -1,6 +1,5 @@
---
date: "2018-05-21T15:00:00+00:00"
title: "Support Options"
slug: "support"
sidebar_position: 20
aliases:

View File

@@ -1,10 +1,8 @@
---
date: "2016-11-08T16:00:00+02:00"
title: "Documentation"
slug: /
sidebar_position: 10
toc: false
draft: false
---
# What is Gitea?

View File

@@ -3,8 +3,7 @@ date: "2016-12-01T16:00:00+02:00"
title: "Installation"
slug: "installation"
sidebar_position: 10
toc: false
draft: false
menu:
sidebar:
name: "Installation"

View File

@@ -1,13 +1,12 @@
---
date: "2018-05-07T13:00:00+02:00"
title: "Compared to other Git hosting"
slug: "comparison"
sidebar_position: 5
aliases:
- /en-us/comparison
---
# Gitea compared to other Git hosting options
# Compared to other Git hosting
To help decide if Gitea is suited for your needs, here is how it compares to other Git self hosted options.

View File

@@ -1,6 +1,5 @@
---
date: "2020-01-16"
title: "Database Preparation"
slug: "database-prep"
sidebar_position: 10
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2017-06-19T12:00:00+02:00"
title: "Installation from binary"
slug: "install-from-binary"
sidebar_position: 15
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2016-12-01T16:00:00+02:00"
title: "Installation from package"
slug: "install-from-package"
sidebar_position: 20
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2016-12-01T16:00:00+02:00"
title: "Installation from source"
slug: "install-from-source"
sidebar_position: 30
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2016-12-01T16:00:00+02:00"
title: "Install on Cloud Provider"
slug: "install-on-cloud-provider"
sidebar_position: 90
aliases:

View File

@@ -1,13 +1,12 @@
---
date: "2020-03-19T19:27:00+02:00"
title: "Install on Kubernetes"
slug: "install-on-kubernetes"
sidebar_position: 80
aliases:
- /en-us/install-on-kubernetes
---
# Installation with Helm (on Kubernetes)
# Install on Kubernetes
Gitea provides a Helm Chart to allow for installation on kubernetes.

View File

@@ -1,6 +1,5 @@
---
date: "2017-07-21T12:00:00+02:00"
title: "Run as a Linux service"
slug: "linux-service"
sidebar_position: 40
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2021-09-02T16:00:00+08:00"
title: "Upgrade from an old Gitea"
slug: "upgrade-from-gitea"
sidebar_position: 100
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2016-12-21T15:00:00-02:00"
title: "Register as a Windows service"
slug: "windows-service"
sidebar_position: 50
aliases:

View File

@@ -1,13 +1,12 @@
---
date: "2020-02-09T20:00:00+02:00"
title: "Installation with Docker (rootless)"
slug: "install-with-docker-rootless"
sidebar_position: 60
aliases:
- /en-us/install-with-docker-rootless
---
# Installation with Docker
# Installation with Docker (rootless)
Gitea provides automatically updated Docker images within its Docker Hub organization. It is
possible to always use the latest stable tag or to use another service that handles updating

View File

@@ -1,6 +1,5 @@
---
date: "2020-03-19T19:27:00+02:00"
title: "Installation with Docker"
slug: "install-with-docker"
sidebar_position: 70
aliases:

View File

@@ -3,8 +3,7 @@ date: "2016-12-27T16:00:00+02:00"
title: "Usage"
slug: "usage"
sidebar_position: 35
toc: false
draft: false
menu:
sidebar:
name: "Usage"

View File

@@ -4,13 +4,13 @@ slug: "actions-variables"
sidebar_position: 25
---
## Variables
# Variables
You can create configuration variables on the user, organization and repository level.
The level of the variable depends on where you created it. When creating a variable, the
key will be converted to uppercase. You need use uppercase on the yaml file.
### Naming conventions
## Naming conventions
The following rules apply to variable names:
@@ -21,12 +21,12 @@ The following rules apply to variable names:
- Variable names must be unique at the level they are created at.
- Variable names must not be `CI`.
### Using variable
## Using variable
After creating configuration variables, they will be automatically filled in the `vars` context.
They can be accessed through expressions like `${{ vars.VARIABLE_NAME }}` in the workflow.
### Precedence
## Precedence
If a variable with the same name exists at multiple levels, the variable at the lowest level takes precedence:
A repository variable will always be chosen over an organization/user variable.

View File

@@ -1,6 +1,5 @@
---
date: " 2022-09-01T20:50:42+0000"
title: "Agit Setup"
slug: "agit-setup"
sidebar_position: 12
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2016-12-01T16:00:00+02:00"
title: "Authentication"
slug: "authentication"
sidebar_position: 10
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2023-08-14T00:00:00+00:00"
title: "Blame File View"
slug: "blame"
sidebar_position: 13
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2024-01-31T00:00:00+00:00"
title: "Blocking a user"
slug: "blocking-user"
sidebar_position: 25
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2021-02-02"
title: "Clone filters (partial clone)"
slug: "clone-filters"
sidebar_position: 25
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2023-05-24T16:00:00+00:00"
title: "Code Owners"
slug: "code-owners"
sidebar_position: 30
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2018-05-10T16:00:00+02:00"
title: "Issue and Pull Request templates"
slug: "issue-pull-request-templates"
sidebar_position: 15
aliases:

View File

@@ -1,13 +1,12 @@
---
date: "2019-11-21T17:00:00-03:00"
title: "Automatically Linked References"
slug: "automatically-linked-references"
sidebar_position: 15
aliases:
- /en-us/automatically-linked-references
---
# Automatically Linked References in Issues, Pull Requests and Commit Messages
# Automatically Linked References
When an issue, pull request or comment is posted, the text description is parsed
in search for references. These references will be shown as links in the Issue View

View File

@@ -1,6 +1,5 @@
---
date: "2022-08-31T17:35:40+08:00"
title: "Merge Message templates"
slug: "merge-message-templates"
sidebar_position: 15
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2023-08-22T14:21:00+08:00"
title: "Multi-factor Authentication (MFA)"
slug: "multi-factor-authentication"
weight: 15
---

View File

@@ -1,6 +1,5 @@
---
date: "2021-12-13:10:10+08:00"
title: "Permissions"
slug: "permissions"
sidebar_position: 14
aliases:

View File

@@ -1,6 +1,5 @@
---
date: "2020-07-06T16:00:00+02:00"
title: "Push"
slug: "push"
sidebar_position: 15
aliases:
@@ -8,9 +7,11 @@ aliases:
- /en-us/push-options
---
# Push
There are some additional features when pushing commits to Gitea server.
# Open PR through Push
## Open PR through Push
When you push commits to a non-default branch for the first time,
you will receive a link you can click on to visit the compare page of your branch compared to your main branch.
@@ -18,12 +19,12 @@ From there, it's easy to create a pull request, even if you want to target anoth
![Gitea Push Hint](/gitea-push-hint.png)
# Push Options
## Push Options
In Gitea `1.13`, support for some [push options](https://git-scm.com/docs/git-push#Documentation/git-push.txt--oltoptiongt)
were added.
## Supported Options
### Supported Options
- `repo.private` (true|false) - Change the repository's visibility.
@@ -37,15 +38,15 @@ Example of changing a repository's visibility to public:
git push -o repo.private=false -u origin main
```
# Push To Create
## Push To Create
Push to create is a feature that allows you to push to a repository that does not exist yet in Gitea. This is useful for automation and for allowing users to create repositories without having to go through the web interface. This feature is disabled by default.
## Enabling Push To Create
### Enabling Push To Create
In the `app.ini` file, set `ENABLE_PUSH_CREATE_USER` to `true` and `ENABLE_PUSH_CREATE_ORG` to `true` if you want to allow users to create repositories in their own user account and in organizations they are a member of respectively. Restart Gitea for the changes to take effect. You can read more about these two options in the [Configuration Cheat Sheet](../administration/config-cheat-sheet.md#repository-repository).
## Using Push To Create
### Using Push To Create
Assuming you have a git repository in the current directory, you can push to a repository that does not exist yet in Gitea by running the following command: