Skip to content

Commit 6171ea7

Browse files
wxiaoguangwxiaoguang
authored
update documents (#19868)
1 parent 8aaba65 commit 6171ea7

File tree

6 files changed

+56
-95
lines changed

6 files changed

+56
-95
lines changed

‎docs/content/doc/developers/guidelines-frontend.md

Lines changed: 1 addition & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Discouraged implementations:
6464
Only mark a function as `async` if and only if there are `await` calls
6565
or `Promise` returns inside the function.
6666

67-
It's not recommended to use `async` event listeners, which may lead to problems.
67+
It's not recommended to use `async` event listeners, which may lead to problems.
6868
The reason is that the code after await is executed outside the event dispatch.
6969
Reference: https://github.com/github/eslint-plugin-github/blob/main/docs/rules/async-preventdefault.md
7070

@@ -73,50 +73,6 @@ it's recommended to use `const _promise = asyncFoo()` to tell readers
7373
that this is done by purpose, we want to call the async function and ignore the Promise.
7474
Some lint rules and IDEs also have warnings if the returned Promise is not handled.
7575

76-
#### DOM Event Listener
77-
78-
```js
79-
el.addEventListener('click', (e) => {
80-
(async () => {
81-
await asyncFoo(); // recommended
82-
// then we shound't do e.preventDefault() after await, no effect
83-
})();
84-
85-
const _promise = asyncFoo(); // recommended
86-
87-
e.preventDefault(); // correct
88-
});
89-
90-
el.addEventListener('async', async (e) => { // not recommended but acceptable
91-
e.preventDefault(); // acceptable
92-
await asyncFoo(); // skip out event dispatch
93-
e.preventDefault(); // WRONG
94-
});
95-
```
96-
97-
#### jQuery Event Listener
98-
99-
```js
100-
$('#el').on('click', (e) => {
101-
(async () => {
102-
await asyncFoo(); // recommended
103-
// then we shound't do e.preventDefault() after await, no effect
104-
})();
105-
106-
const _promise = asyncFoo(); // recommended
107-
108-
e.preventDefault(); // correct
109-
return false; // correct
110-
});
111-
112-
$('#el').on('click', async (e) => { // not recommended but acceptable
113-
e.preventDefault(); // acceptable
114-
return false; // WRONG, jQuery expects the returned value is a boolean, not a Promise
115-
await asyncFoo(); // skip out event dispatch
116-
return false; // WRONG
117-
});
118-
```
119-
12076
### HTML Attributes and `dataset`
12177

12278
We forbid `dataset` usage, its camel-casing behaviour makes it hard to grep for attributes. However there are still some special cases, so the current guideline is:

‎docs/content/page/index.de-de.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Gitea ist ein [Gogs](http://gogs.io)-Fork.
2626
- 2 CPU Kerne und 1GB RAM sind für kleine Teams/Projekte ausreichend.
2727
- Gitea sollte unter einem seperaten nicht-root Account auf UNIX-Systemen ausgeführt werden.
2828
- Achtung: Gitea verwaltet die `~/.ssh/authorized_keys` Datei. Gitea unter einem normalen Benutzer auszuführen könnte dazu führen, dass dieser sich nicht mehr anmelden kann.
29-
- [Git](https://git-scm.com/) Version 1.7.2 oder später wird benötigt. Version 1.9.0 oder später wird empfohlen. Außerdem zu beachten:
29+
- [Git](https://git-scm.com/) Version 2.0 oder später wird benötigt.
3030
- Wenn git >= 2.1.2. und [Git large file storage](https://git-lfs.github.com/) aktiviert ist, dann wird es auch in Gitea verwendbar sein.
3131
- Wenn git >= 2.18, dann wird das Rendern von Commit-Graphen automatisch aktiviert.
3232

‎docs/content/page/index.en-us.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -249,14 +249,25 @@ Windows, on architectures like amd64, i386, ARM, PowerPC, and others.
249249
- Webhooks
250250
- Git Hooks
251251
- Deploy keys
252+
- Package Registries
253+
- Composer
254+
- Conan
255+
- Container
256+
- Generic
257+
- Helm
258+
- Maven
259+
- NPM
260+
- Nuget
261+
- PyPI
262+
- RubyGems
252263

253264
## System Requirements
254265

255266
- A Raspberry Pi 3 is powerful enough to run Gitea for small workloads.
256267
- 2 CPU cores and 1GB RAM is typically sufficient for small teams/projects.
257268
- Gitea should be run with a dedicated non-root system account on UNIX-type systems.
258269
- Note: Gitea manages the `~/.ssh/authorized_keys` file. Running Gitea as a regular user could break that user's ability to log in.
259-
- [Git](https://git-scm.com/) version 1.7.2 or later is required. Version 1.9.0 or later is recommended. Also please note:
270+
- [Git](https://git-scm.com/) version 2.0.0 or later is required.
260271
- [Git Large File Storage](https://git-lfs.github.com/) will be available if enabled when Git >= 2.1.2.
261272
- Git commit-graph rendering will be enabled automatically when Git >= 2.18.
262273

@@ -267,22 +278,21 @@ Windows, on architectures like amd64, i386, ARM, PowerPC, and others.
267278

268279
## Components
269280

270-
* Web framework: [Chi](http://github.com/go-chi/chi)
281+
* Web server framework: [Chi](http://github.com/go-chi/chi)
271282
* ORM: [XORM](https://xorm.io)
272-
* UI components:
273-
* [Semantic UI](http://semantic-ui.com/)
274-
* [GitHub Octicons](https://octicons.github.com/)
275-
* [Font Awesome](http://fontawesome.io/)
276-
* [DropzoneJS](http://www.dropzonejs.com/)
277-
* [Highlight](https://highlightjs.org/)
278-
* [Clipboard](https://zenorocha.github.io/clipboard.js/)
279-
* [CodeMirror](https://codemirror.net/)
280-
* [jQuery MiniColors](https://github.com/claviska/jquery-minicolors)
283+
* UI frameworks:
284+
* [jQuery](https://jquery.com)
285+
* [Fomantic UI](https://fomantic-ui.com)
286+
* [Vue2](https://vuejs.org)
287+
* and various components (see package.json)
288+
* Editors:
289+
* [CodeMirror](https://codemirror.net)
290+
* [EasyMDE](https://github.com/Ionaru/easy-markdown-editor)
291+
* [Monaco Editor](https://microsoft.github.io/monaco-editor)
281292
* Database drivers:
282293
* [github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql)
283294
* [github.com/lib/pq](https://github.com/lib/pq)
284295
* [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3)
285-
* [github.com/pingcap/tidb](https://github.com/pingcap/tidb)
286296
* [github.com/denisenkom/go-mssqldb](https://github.com/denisenkom/go-mssqldb)
287297

288298
## Software and Service Support

‎docs/content/page/index.fr-fr.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -249,27 +249,24 @@ Le but de ce projet est de fournir de la manière la plus simple, la plus rapide
249249

250250
## Navigateurs supportés
251251

252-
- Consultez [Semantic UI](https://github.com/Semantic-Org/Semantic-UI#browser-support) pour la liste des navigateurs supportés.
253-
- La taille minimale supportée officielement est de **1024*768**, l'interface utilisateur peut toujours fonctionner à une taille plus petite, mais ce n'est pas garanti et les problèmes remontés ne seront pas corrigés.
252+
- Chrome, Firefox, Safari, Edge
254253

255254
## Composants
256255

257256
* Framework web : [Chi](http://github.com/go-chi/chi)
258257
* ORM: [XORM](https://xorm.io)
259258
* Interface graphique :
260-
* [Semantic UI](http://semantic-ui.com/)
261-
* [GitHub Octicons](https://octicons.github.com/)
262-
* [Font Awesome](http://fontawesome.io/)
263-
* [DropzoneJS](http://www.dropzonejs.com/)
264-
* [Highlight](https://highlightjs.org/)
265-
* [Clipboard](https://zenorocha.github.io/clipboard.js/)
266-
* [CodeMirror](https://codemirror.net/)
267-
* [jQuery MiniColors](https://github.com/claviska/jquery-minicolors)
259+
* [jQuery](https://jquery.com)
260+
* [Fomantic UI](https://fomantic-ui.com)
261+
* [Vue2](https://vuejs.org)
262+
* [CodeMirror](https://codemirror.net)
263+
* [EasyMDE](https://github.com/Ionaru/easy-markdown-editor)
264+
* [Monaco Editor](https://microsoft.github.io/monaco-editor)
265+
* ... (package.json)
268266
* Connecteurs de base de données :
269267
* [github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql)
270268
* [github.com/lib/pq](https://github.com/lib/pq)
271269
* [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3)
272-
* [github.com/pingcap/tidb](https://github.com/pingcap/tidb)
273270
* [github.com/denisenkom/go-mssqldb](https://github.com/denisenkom/go-mssqldb)
274271

275272
## Logiciels et services

‎docs/content/page/index.zh-cn.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Gitea的首要目标是创建一个极易安装，运行非常快速，安装和
3434
- 支持后台管理面板
3535
- 支持 MySQL、PostgreSQL、SQLite3、MSSQL 和 TiDB(MySQL) 数据库
3636
- 支持多语言本地化（21 种语言）
37+
- 支持软件包注册中心（Composer/Conan/Container/Generic/Helm/Maven/NPM/Nuget/PyPI/RubyGems）
3738

3839
## 系统要求
3940

@@ -42,27 +43,25 @@ Gitea的首要目标是创建一个极易安装，运行非常快速，安装和
4243

4344
## 浏览器支持
4445

45-
- 请根据 [Semantic UI](https://github.com/Semantic-Org/Semantic-UI#browser-support) 查看具体支持的浏览器版本。
46-
- 官方支持的最小 UI 尺寸为 **1024*768**，UI 不一定会在更小尺寸的设备上被破坏，但我们无法保证且不会修复。
46+
- Chrome, Firefox, Safari, Edge
4747

4848
## 组件
4949

5050
* Web框架： [Chi](http://github.com/go-chi/chi)
5151
* ORM: [XORM](https://xorm.io)
52-
* UI组件：
53-
* [Semantic UI](http://semantic-ui.com/)
54-
* [GitHub Octicons](https://octicons.github.com/)
55-
* [Font Awesome](http://fontawesome.io/)
56-
* [DropzoneJS](http://www.dropzonejs.com/)
57-
* [Highlight](https://highlightjs.org/)
58-
* [Clipboard](https://zenorocha.github.io/clipboard.js/)
59-
* [CodeMirror](https://codemirror.net/)
60-
* [jQuery MiniColors](https://github.com/claviska/jquery-minicolors)
52+
* UI 框架：
53+
* [jQuery](https://jquery.com)
54+
* [Fomantic UI](https://fomantic-ui.com)
55+
* [Vue2](https://vuejs.org)
56+
* 更多组件参见 package.json
57+
* 编辑器：
58+
* [CodeMirror](https://codemirror.net)
59+
* [EasyMDE](https://github.com/Ionaru/easy-markdown-editor)
60+
* [Monaco Editor](https://microsoft.github.io/monaco-editor)
6161
* 数据库驱动：
6262
* [github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql)
6363
* [github.com/lib/pq](https://github.com/lib/pq)
6464
* [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3)
65-
* [github.com/pingcap/tidb](https://github.com/pingcap/tidb)
6665
* [github.com/denisenkom/go-mssqldb](https://github.com/denisenkom/go-mssqldb)
6766

6867
## 软件及服务支持

‎docs/content/page/index.zh-tw.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ Gitea 是從 [Gogs](http://gogs.io) Fork 出來的，請閱讀部落格文章 [G
255255
- 在類 UNIX 系統上， 應該以專用的非 root 系統帳號來執行 Gitea。
256256
- 備註：Gitea 管理著 `~/.ssh/authorized_keys` 檔案。以一般身份使用者執行 Gitea 可能會破壞該使用者的登入能力。
257257

258-
- [Git](https://git-scm.com/) 的最低需求為 1.7.2 或更新版本。建議使用 1.9.0 或更新版本。並請留意：
258+
- [Git](https://git-scm.com/) 的最低需求為 2.0 或更新版本。
259259
- 當 git 版本 >= 2.1.2 時，可啟用 Git [large file storage](https://git-lfs.github.com/)。
260260
- 當 git 版本 >= 2.18 時，將自動啟用 Git 提交線圖渲染。
261261

@@ -269,20 +269,19 @@ Gitea 是從 [Gogs](http://gogs.io) Fork 出來的，請閱讀部落格文章 [G
269269
- Web 框架： [Chi](http://github.com/go-chi/chi)
270270
- ORM： [XORM](https://xorm.io)
271271
- UI 元件：
272-
- [Semantic UI](http://semantic-ui.com/)
273-
- [GitHub Octicons](https://octicons.github.com/)
274-
- [Font Awesome](http://fontawesome.io/)
275-
- [DropzoneJS](http://www.dropzonejs.com/)
276-
- [Highlight](https://highlightjs.org/)
277-
- [Clipboard](https://zenorocha.github.io/clipboard.js/)
278-
- [CodeMirror](https://codemirror.net/)
279-
- [jQuery MiniColors](https://github.com/claviska/jquery-minicolors)
272+
* [jQuery](https://jquery.com)
273+
* [Fomantic UI](https://fomantic-ui.com)
274+
* [Vue2](https://vuejs.org)
275+
* [CodeMirror](https://codemirror.net)
276+
* [EasyMDE](https://github.com/Ionaru/easy-markdown-editor)
277+
* [Monaco Editor](https://microsoft.github.io/monaco-editor)
278+
* ... (package.json)
280279
- 資料庫驅動程式：
281-
- [github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql)
282-
- [github.com/lib/pq](https://github.com/lib/pq)
283-
- [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3)
284-
- [github.com/pingcap/tidb](https://github.com/pingcap/tidb)
285-
- [github.com/denisenkom/go-mssqldb](https://github.com/denisenkom/go-mssqldb)
280+
* [github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql)
281+
* [github.com/lib/pq](https://github.com/lib/pq)
282+
* [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3)
283+
* [github.com/denisenkom/go-mssqldb](https://github.com/denisenkom/go-mssqldb)
284+
286285

287286
## 軟體和服務支援
288287

0 commit comments

Comments
 (0)