]> source.dussan.org Git - gitea.git/commitdiff
Move documents under actions (#31110) (#31116)
authorGiteabot <teabot@gitea.io>
Mon, 27 May 2024 15:05:49 +0000 (23:05 +0800)
committerGitHub <noreply@github.com>
Mon, 27 May 2024 15:05:49 +0000 (23:05 +0800)
Backport #31110 by @lunny

Move secrets and badge under actions

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
docs/content/usage/actions/badge.en-us.md [new file with mode: 0644]
docs/content/usage/actions/secrets.en-us.md [new file with mode: 0644]
docs/content/usage/actions/secrets.zh-cn.md [new file with mode: 0644]
docs/content/usage/badge.en-us.md [deleted file]
docs/content/usage/secrets.en-us.md [deleted file]
docs/content/usage/secrets.zh-cn.md [deleted file]

diff --git a/docs/content/usage/actions/badge.en-us.md b/docs/content/usage/actions/badge.en-us.md
new file mode 100644 (file)
index 0000000..de7a34f
--- /dev/null
@@ -0,0 +1,35 @@
+---
+date: "2023-02-25T00:00:00+00:00"
+title: "Badge"
+slug: "badge"
+sidebar_position: 11
+toc: false
+draft: false
+menu:
+  sidebar:
+    parent: "actions"
+    name: "Badge"
+    sidebar_position: 11
+    identifier: "Badge"
+---
+
+# Badge
+
+Gitea has its builtin Badge system which allows you to display the status of your repository in other places. You can use the following badges:
+
+## Workflow Badge
+
+The Gitea Actions workflow badge is a badge that shows the status of the latest workflow run.
+It is designed to be compatible with [GitHub Actions workflow badge](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge).
+
+You can use the following URL to get the badge:
+
+```
+https://your-gitea-instance.com/{owner}/{repo}/actions/workflows/{workflow_file}?branch={branch}&event={event}
+```
+
+- `{owner}`: The owner of the repository.
+- `{repo}`: The name of the repository.
+- `{workflow_file}`: The name of the workflow file.
+- `{branch}`: Optional. The branch of the workflow. Default to your repository's default branch.
+- `{event}`: Optional. The event of the workflow. Default to none.
diff --git a/docs/content/usage/actions/secrets.en-us.md b/docs/content/usage/actions/secrets.en-us.md
new file mode 100644 (file)
index 0000000..5bf1f1a
--- /dev/null
@@ -0,0 +1,37 @@
+---
+date: "2022-12-19T21:26:00+08:00"
+title: "Secrets"
+slug: "secrets"
+sidebar_position: 50
+draft: false
+toc: false
+menu:
+  sidebar:
+    parent: "actions"
+    name: "Secrets"
+    sidebar_position: 50
+    identifier: "usage-secrets"
+---
+
+# Secrets
+
+Secrets allow you to store sensitive information in your user, organization or repository.
+Secrets are available on Gitea 1.19+ and are only visible in 1.20+ when ACTIONS are enabled.
+
+# Naming your secrets
+
+The following rules apply to secret names:
+
+- Secret names can only contain alphanumeric characters (`[a-z]`, `[A-Z]`, `[0-9]`) or underscores (`_`). Spaces are not allowed.
+
+- Secret names must not start with the `GITHUB_` and `GITEA_` prefix.
+
+- Secret names must not start with a number.
+
+- Secret names are not case-sensitive.
+
+- Secret names must be unique at the level they are created at.
+
+For example, a secret created at the repository level must have a unique name in that repository, and a secret created at the organization level must have a unique name at that level.
+
+If a secret with the same name exists at multiple levels, the secret at the lowest level takes precedence. For example, if an organization-level secret has the same name as a repository-level secret, then the repository-level secret takes precedence.
diff --git a/docs/content/usage/actions/secrets.zh-cn.md b/docs/content/usage/actions/secrets.zh-cn.md
new file mode 100644 (file)
index 0000000..939042f
--- /dev/null
@@ -0,0 +1,37 @@
+---
+date: "2023-05-23T09:00:00+08:00"
+title: "密钥管理"
+slug: "secrets"
+sidebar_position: 50
+draft: false
+toc: false
+menu:
+  sidebar:
+    parent: "actions"
+    name: "密钥管理"
+    sidebar_position: 50
+    identifier: "usage-secrets"
+---
+
+# 密钥管理
+
+密钥管理允许您在用户、组织或仓库中存储敏感信息。
+密钥管理在 Gitea 1.19+ 版本中可用。
+
+# 设置密钥名称
+
+以下规则适用于密钥名称:
+
+- 密钥名称只能包含字母数字字符 (`[a-z]`, `[A-Z]`, `[0-9]`) 或下划线 (`_`)。不允许使用空格。
+
+- 密钥名称不能以 `GITHUB_` 和 `GITEA_` 前缀开头。
+
+- 密钥名称不能以数字开头。
+
+- 密钥名称不区分大小写。
+
+- 密钥名称在创建它们的级别上必须是唯一的。
+
+例如,对于在仓库级别创建的密钥,它在该仓库中必须具有唯一的名称;对于在组织级别创建的密钥,它在该级别上必须具有唯一的名称。
+
+如果在多个级别上存在具有相同名称的密钥,则最低级别的密钥优先生效。例如,如果组织级别的密钥与仓库级别的密钥具有相同的名称,则仓库级别的密钥将优先生效。
diff --git a/docs/content/usage/badge.en-us.md b/docs/content/usage/badge.en-us.md
deleted file mode 100644 (file)
index 212134e..0000000
+++ /dev/null
@@ -1,37 +0,0 @@
----
-date: "2023-02-25T00:00:00+00:00"
-title: "Badge"
-slug: "badge"
-sidebar_position: 11
-toc: false
-draft: false
-aliases:
-  - /en-us/badge
-menu:
-  sidebar:
-    parent: "usage"
-    name: "Badge"
-    sidebar_position: 11
-    identifier: "Badge"
----
-
-# Badge
-
-Gitea has its builtin Badge system which allows you to display the status of your repository in other places. You can use the following badges:
-
-## Workflow Badge
-
-The Gitea Actions workflow badge is a badge that shows the status of the latest workflow run.
-It is designed to be compatible with [GitHub Actions workflow badge](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge).
-
-You can use the following URL to get the badge:
-
-```
-https://your-gitea-instance.com/{owner}/{repo}/actions/workflows/{workflow_file}?branch={branch}&event={event}
-```
-
-- `{owner}`: The owner of the repository.
-- `{repo}`: The name of the repository.
-- `{workflow_file}`: The name of the workflow file.
-- `{branch}`: Optional. The branch of the workflow. Default to your repository's default branch.
-- `{event}`: Optional. The event of the workflow. Default to none.
diff --git a/docs/content/usage/secrets.en-us.md b/docs/content/usage/secrets.en-us.md
deleted file mode 100644 (file)
index 8ad6746..0000000
+++ /dev/null
@@ -1,39 +0,0 @@
----
-date: "2022-12-19T21:26:00+08:00"
-title: "Secrets"
-slug: "secrets"
-sidebar_position: 50
-draft: false
-toc: false
-aliases:
-  - /en-us/secrets
-menu:
-  sidebar:
-    parent: "usage"
-    name: "Secrets"
-    sidebar_position: 50
-    identifier: "usage-secrets"
----
-
-# Secrets
-
-Secrets allow you to store sensitive information in your user, organization or repository.
-Secrets are available on Gitea 1.19+ and are only visible in 1.20+ when ACTIONS are enabled.
-
-# Naming your secrets
-
-The following rules apply to secret names:
-
-- Secret names can only contain alphanumeric characters (`[a-z]`, `[A-Z]`, `[0-9]`) or underscores (`_`). Spaces are not allowed.
-
-- Secret names must not start with the `GITHUB_` and `GITEA_` prefix.
-
-- Secret names must not start with a number.
-
-- Secret names are not case-sensitive.
-
-- Secret names must be unique at the level they are created at.
-
-For example, a secret created at the repository level must have a unique name in that repository, and a secret created at the organization level must have a unique name at that level.
-
-If a secret with the same name exists at multiple levels, the secret at the lowest level takes precedence. For example, if an organization-level secret has the same name as a repository-level secret, then the repository-level secret takes precedence.
diff --git a/docs/content/usage/secrets.zh-cn.md b/docs/content/usage/secrets.zh-cn.md
deleted file mode 100644 (file)
index 40e80dc..0000000
+++ /dev/null
@@ -1,39 +0,0 @@
----
-date: "2023-05-23T09:00:00+08:00"
-title: "密钥管理"
-slug: "secrets"
-sidebar_position: 50
-draft: false
-toc: false
-aliases:
-  - /zh-cn/secrets
-menu:
-  sidebar:
-    parent: "usage"
-    name: "密钥管理"
-    sidebar_position: 50
-    identifier: "usage-secrets"
----
-
-# 密钥管理
-
-密钥管理允许您在用户、组织或仓库中存储敏感信息。
-密钥管理在 Gitea 1.19+ 版本中可用。
-
-# 设置密钥名称
-
-以下规则适用于密钥名称:
-
-- 密钥名称只能包含字母数字字符 (`[a-z]`, `[A-Z]`, `[0-9]`) 或下划线 (`_`)。不允许使用空格。
-
-- 密钥名称不能以 `GITHUB_` 和 `GITEA_` 前缀开头。
-
-- 密钥名称不能以数字开头。
-
-- 密钥名称不区分大小写。
-
-- 密钥名称在创建它们的级别上必须是唯一的。
-
-例如,对于在仓库级别创建的密钥,它在该仓库中必须具有唯一的名称;对于在组织级别创建的密钥,它在该级别上必须具有唯一的名称。
-
-如果在多个级别上存在具有相同名称的密钥,则最低级别的密钥优先生效。例如,如果组织级别的密钥与仓库级别的密钥具有相同的名称,则仓库级别的密钥将优先生效。