0
0
mirror of https://gitea.com/gitea/docs.git synced 2025-03-16 21:30:25 +00:00

51 Commits

Author SHA1 Message Date
52933671d8 use docker.gitea.com docker URLs (#175)
Reviewed-on: https://gitea.com/gitea/docs/pulls/175
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: techknowlogick <techknowlogick@gitea.com>
Co-committed-by: techknowlogick <techknowlogick@gitea.com>
2025-02-28 15:36:37 +00:00
a97908040d Update some docs (#144)
Close #143

- Add `ORG_PAGING_NUM`
- Remove `hashFiles` from unsupported workflows syntax

Reviewed-on: https://gitea.com/gitea/docs/pulls/144
Reviewed-by: techknowlogick <techknowlogick@noreply.gitea.com>
Co-authored-by: Zettat123 <zettat123@gmail.com>
Co-committed-by: Zettat123 <zettat123@gmail.com>
2025-01-09 05:27:03 +00:00
5c11efcedf Improve config cheat sheet and update SSH_USER (#138)
Co-authored-by: Lunny Xiao <lunny@noreply.gitea.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/138
Reviewed-by: Lunny Xiao <lunny@noreply.gitea.com>
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-committed-by: wxiaoguang <wxiaoguang@gmail.com>
2025-01-07 22:40:06 +00:00
d97b557d9f Remove dead marketplace links (#139)
both have removed gitea from their marketplaces

Reviewed-on: https://gitea.com/gitea/docs/pulls/139
Co-authored-by: TheFox0x7 <thefox0x7@gmail.com>
Co-committed-by: TheFox0x7 <thefox0x7@gmail.com>
2025-01-05 18:33:08 +00:00
8f872a636d Document for GITEA_RUNNER_REGISTRATION_TOKEN env (#132)
Co-authored-by: Lunny Xiao <lunny@noreply.gitea.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/132
Reviewed-by: Lunny Xiao <lunny@noreply.gitea.com>
Co-authored-by: Zettat123 <zettat123@gmail.com>
Co-committed-by: Zettat123 <zettat123@gmail.com>
2024-12-24 20:32:57 +00:00
dc5a65d91a fix: add space for url (#129)
![image.png](/attachments/cb407e73-014e-41d5-be43-2571f1dfcde1)

Resolve the problem that was wrongly detected as a URL.

Co-authored-by: shugen002 <10257291+shugen002@users.noreply.github.com>
Co-authored-by: Lunny Xiao <lunny@noreply.gitea.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/129
Reviewed-by: blumia <blumia@noreply.gitea.com>
Reviewed-by: Lunny Xiao <lunny@noreply.gitea.com>
Co-authored-by: shugen <shugen@noreply.gitea.com>
Co-committed-by: shugen <shugen@noreply.gitea.com>
2024-12-19 20:33:24 +00:00
a0feb8c4fc Add new version 1.23.0-rc0 (#128)
Reviewed-on: https://gitea.com/gitea/docs/pulls/128
2024-12-18 07:44:42 +00:00
177b9d8d87 Add ALLOW_FORK_INTO_SAME_OWNER and fix legacy syntax (#122)
Co-authored-by: Lunny Xiao <lunny@noreply.gitea.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/122
Reviewed-by: Lunny Xiao <lunny@noreply.gitea.com>
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-committed-by: wxiaoguang <wxiaoguang@gmail.com>
2024-12-18 07:20:36 +00:00
7a4e79c937 use fqin for container images (#125)
It's generally considered a better practice and it's more portable allowing podman to work without having to modify the name.

Reviewed-on: https://gitea.com/gitea/docs/pulls/125
Reviewed-by: Lunny Xiao <lunny@noreply.gitea.com>
Co-authored-by: TheFox0x7 <thefox0x7@gmail.com>
Co-committed-by: TheFox0x7 <thefox0x7@gmail.com>
2024-12-17 20:23:46 +00:00
fc7bdfc7b6 Improve the signing documentations (#108)
Reviewed-on: https://gitea.com/gitea/docs/pulls/108
2024-11-25 05:36:44 +00:00
ddc1db3637 Move authentication from usage to administration (#105)
Reviewed-on: https://gitea.com/gitea/docs/pulls/105
2024-11-24 02:32:42 +00:00
79767d83a7 Update ALLOWED_TYPES (#96)
Reviewed-on: https://gitea.com/gitea/docs/pulls/96
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-committed-by: wxiaoguang <wxiaoguang@gmail.com>
2024-11-15 05:53:35 +00:00
5e9c955979 Add DEFAULT_MIRROR_REPO_UNITS and DEFAULT_TEMPLATE_REPO_UNITS options (#91)
Related to https://github.com/go-gitea/gitea/pull/32416

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/91
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: Zettat123 <zettat123@gmail.com>
Co-committed-by: Zettat123 <zettat123@gmail.com>
2024-11-13 00:26:38 +00:00
e8344b03cb Document Reverse Proxy authentication for API (#84)
I figured out that the reverse proxy authentication for the API is supported (implemented with https://github.com/go-gitea/gitea/pull/26703). This will update the documentation to the current state.

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: Philipp Arndt <2f.mail@gmx.de>
Reviewed-on: https://gitea.com/gitea/docs/pulls/84
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: philipparndt <philipparndt@noreply.gitea.com>
Co-committed-by: philipparndt <philipparndt@noreply.gitea.com>
2024-11-12 19:35:18 +00:00
05271fd4e6 Update faq for actions to correct wrong documentations. (#85)
- [x] User-level runners are supported from 1.20
- [x] Actions are enabled by default from 1.21

Reviewed-on: https://gitea.com/gitea/docs/pulls/85
2024-10-28 18:04:52 +00:00
5bfca46fd6 Merge branch 'main' into lunny/update_agit_forcepush 2024-10-22 06:42:24 +00:00
0c55d89c91 update cn docs 2024-10-18 09:55:29 +08:00
5f07f6c79a Update old versions 2024-10-11 00:06:36 -07:00
bea0fb7387 Use camo.Always instead of camo.Allways (#73)
ref: https://github.com/go-gitea/gitea/pull/32097
Reviewed-on: https://gitea.com/gitea/docs/pulls/73
2024-09-25 17:11:33 +00:00
d9cc7c43c0 Enable compression for Actions logs by default (#66)
Follow https://github.com/go-gitea/gitea/pull/32013

Reviewed-on: https://gitea.com/gitea/docs/pulls/66
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: Jason Song <i@wolfogre.com>
Co-committed-by: Jason Song <i@wolfogre.com>
2024-09-10 02:32:33 +00:00
1257064c05 Improve agit usage (#63)
Reviewed-on: https://gitea.com/gitea/docs/pulls/63
2024-09-06 19:46:32 +00:00
97339dc250 Remove unnecessary _index.md 2024-09-02 17:57:43 -07:00
7a8bc94a8a Adjust packages and actions articles' sequence on the sidebar 2024-09-02 17:52:58 -07:00
2f7d104417 Fix some versions 2024-08-31 23:36:04 -07:00
1f23956442 replace all global variables with right value 2024-08-31 23:14:38 -07:00
5ecafa9a56 Fix outdated cheat sheet about ALLOWED_DOMAINS (#55)
Reviewed-on: https://gitea.com/gitea/docs/pulls/55
Reviewed-by: yp05327 <yp05327@noreply.gitea.com>
2024-08-22 04:09:23 +00:00
9003c4a604 'workflow_dispatch' unsupported description removed (#54)
For PR: [go-gitea/gitea#28163](https://github.com/go-gitea/gitea/pull/28163)

I saw that there was no description of the use of a single syntax in the original document, so I simply deleted the description that 'workflow_dispatch does not support'

Co-authored-by: pangliang <418094911@qq.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/54
Reviewed-by: Denys Konovalov <denyskon@noreply.gitea.com>
Reviewed-by: techknowlogick <techknowlogick@noreply.gitea.com>
Co-authored-by: pangliang <pangliang@noreply.gitea.com>
Co-committed-by: pangliang <pangliang@noreply.gitea.com>
2024-08-19 20:31:59 +00:00
56e5cc026b Update issue template for issue assignees (#48)
Related to https://github.com/go-gitea/gitea/pull/31083

Reviewed-on: https://gitea.com/gitea/docs/pulls/48
Reviewed-by: Jason Song <wolfogre@noreply.gitea.com>
Co-authored-by: Zettat123 <zettat123@gmail.com>
Co-committed-by: Zettat123 <zettat123@gmail.com>
2024-08-13 02:27:18 +00:00
4d7c41947b Add LOG_COMPRESSION (#50)
Follow https://github.com/go-gitea/gitea/pull/31761

Reviewed-on: https://gitea.com/gitea/docs/pulls/50
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: Jason Song <i@wolfogre.com>
Co-committed-by: Jason Song <i@wolfogre.com>
2024-08-09 16:24:28 +00:00
eebb6b1528 Add storage configuration hint to simplify the configuration (#44)
Reviewed-on: https://gitea.com/gitea/docs/pulls/44
2024-08-09 02:29:24 +00:00
b7d3335676 Add more description for LFS_JWT_SECRET (#46)
Fix https://github.com/go-gitea/gitea/issues/22727

Reviewed-on: https://gitea.com/gitea/docs/pulls/46
2024-08-07 01:51:54 +00:00
af22422e1a Update meta data of docs 2024-08-06 16:44:42 -07:00
56e120e1d8 Add LOG_RETENTION_DAYS (#40)
Related to https://github.com/go-gitea/gitea/pull/31735

Reviewed-on: https://gitea.com/gitea/docs/pulls/40
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: Jason Song <i@wolfogre.com>
Co-committed-by: Jason Song <i@wolfogre.com>
2024-08-02 03:33:18 +00:00
fa80574eb7 external-renders: add agrs --global for pipx (#33)
Add `--global` to fix jupyter to /usr/local/bin

Reviewed-on: https://gitea.com/gitea/docs/pulls/33
Reviewed-by: yp05327 <yp05327@noreply.gitea.com>
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: ifurther <55025025+ifurther@users.noreply.github.com>
Co-committed-by: ifurther <55025025+ifurther@users.noreply.github.com>
2024-07-28 03:46:04 +00:00
5df20429a2 docs(reverse-proxies.md): Update zh-cn translation of reverse-proxies.md (#29)
Update the zh-cn translation of reverse-proxies.md of current version and version 1.22 (since reverse-proxies.md of them are same). The translation is based on English version of reverse-proxies.md of current version.

Resolve [issue 24](https://gitea.com/gitea/docs/issues/24)

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-on: https://gitea.com/gitea/docs/pulls/29
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: zeauw <me@zeauw.dev>
Co-committed-by: zeauw <me@zeauw.dev>
2024-07-17 03:08:53 +00:00
7e77e7fb39 Add missing doc from main repository (#4)
Copy from https://github.com/go-gitea/gitea/pull/31211/files
Author: @MaxWipfli

Add missing documentation for https://github.com/go-gitea/gitea/pull/30268

Reviewed-on: https://gitea.com/gitea/docs/pulls/4
2024-06-15 03:10:51 +00:00
ab2cdde840 Fix more links and problems (#3)
Reviewed-on: https://gitea.com/gitea/docs/pulls/3
2024-06-14 08:53:10 +00:00
9a8396aa29 Fix broken links (#1)
- Always use a relative markdown link so that we can jump even if we edit it in local env or read it in code hosting server.

Reviewed-on: https://gitea.com/gitea/docs/pulls/1
2024-06-14 05:53:15 +00:00
b4dddf8804 Use docusaurus warning/note syntax instead markdown 2024-06-07 18:03:08 +08:00
91cd95dba0 Fix links 2024-06-07 00:21:50 +08:00
c88deee1a6 Some small improvements 2024-06-06 22:49:46 +08:00
b9e0a85c9b Use a formal docusaurus i18n structure 2024-06-06 20:44:06 +08:00
377f435a2b Add version of 1.22 (#137)
Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/137
2024-05-27 13:52:22 +00:00
b999a774bd Add 1.21rc0 2023-10-01 21:01:57 +08:00
1f003f6298 translation for blog on navbar and remove target="_blank" for internal links (#44)
- Do not use `target="_blank"`for gitea websites on navbar (same behavior as about.gitea.com)

- Translate "blog" on navbar for zh-cn

Before:

![Screen Shot 2023-07-12 at 17.40.27](/attachments/8c2d2a0d-5b66-4396-a962-9dd5aec20aaa)

After:

![Screen Shot 2023-07-12 at 17.41.47](/attachments/65822b16-9ba9-4452-94b1-f8c145ffd78b)

Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/44
Co-authored-by: HesterG <hestergong@gmail.com>
Co-committed-by: HesterG <hestergong@gmail.com>
2023-07-12 12:58:44 +00:00
7ca358b43e Add v1.20 documentation (#28)
Modified `loop_docs.sh` to take `version` and `locale` and params so do not need other `loop_docs*` scripts.

Need confirmation with version information for 1.20 and latest.
Like version in `static/20-swagger.json` and `static/latest-swagger.json`, and version used to replace `{{< version >}}`

Will wait for a stable version for 1.20

![Screen Shot 2023-06-14 at 12.12.18](/attachments/1b316978-0daf-46bb-90a7-632a0fc80898)

Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/28
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: HesterG <hestergong@gmail.com>
Co-committed-by: HesterG <hestergong@gmail.com>
2023-06-14 07:05:13 +00:00
1ba3ac7c99 Add outdated component to outdated documents (#25)
- `git log` needs all commit history to compare latest commit of files, so changed `git clone --depth=1` to `git clone`. This will make the step take longer, so might be improved if there is a better way.

- `src/theme/MDXContent/index.js` is from [ejecting of the component](https://docusaurus.io/docs/swizzling#ejecting) inside `@docusaurus/theme-classic` plugin, and this one is safe to eject according to docusaurus

    ![Screen Shot 2023-06-06 at 12.12.28](/attachments/17a3a84b-cec0-4849-8bd6-9e0471d9536f)

    ![Screen Shot 2023-06-06 at 12.12.15](/attachments/58bba321-3cfb-4a8b-8aeb-84422a06c472)

- [Outdated component style reference](https://mui.com/material-ui/react-alert/)

- Added [`Translate` component](https://docusaurus.io/docs/next/docusaurus-core#translate) to `Outdated` so it can be localized. [reference](https://docusaurus.io/docs/next/i18n/tutorial#translate-your-react-code)

- One way to check for the specific outdated documents:

    search for `lastest commit timestamp` in [prepare nightly docs and prepare 1.19 docs steps](https://gitea.com/gitea/gitea-docusaurus/actions/runs/74)

# After

The Chinese documents that are outdated (latest commit is ealier than laster commit of English version):

![Screen Shot 2023-06-06 at 13.04.24](/attachments/e5d16267-d8d8-434e-89b1-138d04ec92a3)

![Screen Shot 2023-06-06 at 13.05.07](/attachments/af8f996a-5318-4f89-841f-b27a4903a27d)

![Screen Shot 2023-06-06 at 13.05.14](/attachments/e6aba31b-46ba-4a32-ad81-81007e0f711e)

Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/25
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: HesterG <hestergong@gmail.com>
Co-committed-by: HesterG <hestergong@gmail.com>
2023-06-08 03:34:23 +00:00
c123ee5449 Use capitals for actions and packages (#19)
![Screen Shot 2023-05-29 at 18.18.31](/attachments/1255a8a5-f46f-4e2e-8a43-398a292fff2a)

Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/19
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: HesterG <hestergong@gmail.com>
Co-committed-by: HesterG <hestergong@gmail.com>
2023-05-29 10:28:05 +00:00
c911962cd6 fix typo and some seds for <empty> (#15)
# Before:

![Screen Shot 2023-05-26 at 15.48.12](/attachments/09d9a965-1587-40c9-b81b-e8416ac0c226)![Screen Shot 2023-05-26 at 15.48.17](/attachments/8beda8a1-5c49-4c87-95e7-e4aa95e56ec9)![Screen Shot 2023-05-26 at 15.48.57](/attachments/21dad81e-eed1-4280-bbb4-eeda039bec41)![Screen Shot 2023-05-26 at 16.14.44](/attachments/07a3148a-52ea-43bb-8e07-c0d8f31d1c24)

# After:

![Screen Shot 2023-05-26 at 16.02.38](/attachments/24239f32-6e9a-487c-8532-b6bd22ca6a50)(/attachments/85c184f3-58ca-4616-bb9d-9afacbc59290)![Screen Shot 2023-05-26 at 16.03.02](/attachments/4952880a-3254-4139-8943-ff37a9797bd7)![Screen Shot 2023-05-26 at 16.05.03](/attachments/ef77be92-2c60-4962-8b0a-efeed63a663b)![Screen Shot 2023-05-26 at 16.15.22](/attachments/22ea1d0b-2838-488d-92c7-e2db8e53ebae)

Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/15
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: HesterG <hestergong@gmail.com>
Co-committed-by: HesterG <hestergong@gmail.com>
2023-05-26 17:49:55 +08:00
20c970682b Add Chinese support (#13)
# Main changes and Some notices

- Chines Docs should be put into corresponding versions' folders under `i18n/zh-cn/docusaurus-plugin-content-docs`. See [translate-markdown-files](https://docusaurus.io/docs/i18n/tutorial#translate-markdown-files) for reference. And also [srs-docs](https://github.com/ossrs/srs-docs) is a project that can be used as a reference. So changed the related paths in `loop_docs*` scripts.

- The markdown files under `docs/<version>` and `i18n/zh-cn/docusaurus-plugin-content-docs/<version>` must have the same name to be referred as translated. Files inside docs are corresponding to `current` version.
For example, `docs/administration/mail-templates.md` and `i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/mail-templates.md`.  Filename of `mail-templates.md` must be the same (cannot be `mail-templates.zh-cn.md` and `mail-templates.us-en.md`)
So trim the `.en-us.md` and `.zh-cn.md` to `.md` to ensure the same names inside `loop_docs*` scripts.

- Used `npx docusaurus write-translations --locale zh-cn` to do sidebar, footer, and header translations, so no need to keep `sideBarCN` anymore. [reference](https://docusaurus.io/docs/cli#docusaurus-write-translations-sitedir)

- Local Tests for `en` and `zh-cn` are separeted, run the following on local respectly to test them

    ```bash
    # test en version
    npm run start
    # test zh-cn version
    npm run start -- --locale zh-cn
    ```

- If wants to test `en` and `zh-cn` both at the same time, run build and serve

    ```
    npm run build
    npm run serve
    ```

- Added some indexed page, for example:

![Screen Shot 2023-05-26 at 13.49.34](/attachments/9eeb3d38-c309-457d-9015-053b9c5ca8d6)

![Screen Shot 2023-05-26 at 13.49.49](/attachments/fc348d17-ce4c-4c4d-9240-b69add4ef06e)

Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/13
Co-authored-by: HesterG <hestergong@gmail.com>
Co-committed-by: HesterG <hestergong@gmail.com>
2023-05-26 14:30:13 +08:00