summaryrefslogtreecommitdiffstats
path: root/docs/content/doc
Commit message (Collapse)AuthorAgeFilesLines
* Update documentation to explain which projects allow Gitea to host static ↵65432023-04-114-3/+26
| | | | | | | | | | | | pages (#23993) close #23521 --------- Signed-off-by: 6543 <6543@obermui.de> Co-authored-by: delvh <dev.lh@web.de> Co-authored-by: a1012112796 <1012112796@qq.com> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Prefer native parser for SSH public key parsing (#23798)Leon Busch-George2023-04-111-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Without this patch, the setting SSH.StartBuiltinServer decides whether the native (Go) implementation is used rather than calling 'ssh-keygen'. It's possible for 'using ssh-keygen' and 'using the built-in server' to be independent. In fact, the gitea rootless container doesn't ship ssh-keygen and can be configured to use the host's SSH server - which will cause the public key parsing mechanism to break. This commit changes the decision to be based on SSH.KeygenPath instead. Any existing configurations with a custom KeygenPath set will continue to function. The new default value of '' selects the native version. The downside of this approach is that anyone who has relying on plain 'ssh-keygen' to have special properties will now be using the native version instead. I assume the exec-variant is only there because /x/crypto/ssh didn't support ssh-ed25519 until 2016. I don't see any other reason for using it so it might be an acceptable risk. Fixes #23363 EDIT: this message was garbled when I tried to get the commit description back in.. Trying to reconstruct it: ## :warning: BREAKING :warning: Users who don't have SSH.KeygenPath explicitly set and rely on the ssh-keygen binary need to set SSH.KeygenPath to 'ssh-keygen' in order to be able to continue using it for public key parsing. There was something else but I can't remember at the moment. EDIT2: It was about `make test` and `make lint`. Can't get them to run. To reproduce the issue, I installed `golang` in `docker.io/node:16` and got: ``` ... go: mvdan.cc/xurls/v2@v2.4.0: unknown revision mvdan.cc/xurls/v2.4.0 go: gotest.tools/v3@v3.4.0: unknown revision gotest.tools/v3.4.0 ... go: gotest.tools/v3@v3.0.3: unknown revision gotest.tools/v3.0.3 ... go: error loading module requirements ``` Signed-off-by: Leon M. Busch-George <leon@georgemail.eu>
* Fix markdownlint (#24024)silverwind2023-04-091-1/+1
| | | | Should fix the currently broken CI, and also validate via new `complicance-docs` pipeline.
* Fix https setup doc zh-cn (#24015)Lunny Xiao2023-04-091-6/+6
|
* Reference the `zh-CN` version of `reverse-proxies` in `https-support` (#24016)Yarden Shoham2023-04-091-1/+1
|
* Fix lint problem in `https-support.zh-cn.md` (#24014)Yarden Shoham2023-04-091-1/+1
| | | https://github.com/DavidAnson/markdownlint/blob/v0.26.2/doc/Rules.md#md051
* docs: HTTPS configuration for zh-cn (#23039)阿卡林刘2023-04-091-0/+101
| | | | | added the Use HTTPS Configuration section Translation Chinese Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Merge `push to create`, `open PR from push`, and `push options` docs ↵Lunny Xiao2023-04-074-73/+107
| | | | | | | | | | | | articles into one (#23744) Add documentation for this feature. <img width="734" alt="gitea-push-hint" src="https://user-images.githubusercontent.com/81045/227921177-af08ab76-7556-4a69-8da9-bb59cec1388b.png"> --------- Co-authored-by: delvh <dev.lh@web.de>
* Adjust some documentations titles (#23941)Lunny Xiao2023-04-0624-47/+51
| | | As title.
* docs: make the required backticks in email password more explicit (#23923)alex2023-04-041-1/+1
| | | | updated the example config to make the needed backticks around the password more obvious
* docs: fix typo (#23924)alex2023-04-041-1/+1
| | | fixes a minor typo in the email templates page
* Update docs markdown file weight to make it clear (#23909)Lunny Xiao2023-04-0489-97/+117
| | | | For Docusaurus, it needs a meta data named `sidebar_position`, so we copy all `weight` under `menu/sidebar` as top meta key.
* Rename actions unit to `repo.actions` and add docs for it (#23733)Jason Song2023-04-031-2/+2
| | | | | | | | | | I neglected that the `NameKey` of `Unit` is not only for translation, but also configuration. So it should be `repo.actions` to maintain consistency. ## :warning: BREAKING :warning: If users already use `actions.actions` in `DISABLED_REPO_UNITS` or `DEFAULT_REPO_UNITS`, it will be treated as an invalid unit key.
* Add ONLY_SHOW_RELEVANT_REPOS back, fix explore page bug, make code more ↵wxiaoguang2023-03-291-1/+3
| | | | | | | | | | | | | | | | | | | strict (#23766) Follow #21962 After I eat my own dogfood, I would say that ONLY_SHOW_RELEVANT_REPOS=false is necessary for many private/enterprise instances, because many private repositories do not have "description/topic", users just want to search by their names. This PR also adds `PageIsExploreRepositories` check, to make code more strict, because the `search` template is shared for different purpose. And during the test, I found a bug that the "Search" button didn't respect the "relevant" parameter, so this PR fixes the bug by the way together. I think this PR needs to be backported.
* Add meilisearch support (#23136)techknowlogick2023-03-281-2/+2
| | | | | Add meilisearch support Fixes #20665
* Implement Issue Config (#20956)JakobDev2023-03-281-0/+38
| | | | | | | | Closes #20955 This PR adds the possibility to disable blank Issues, when the Repo has templates. This can be done by creating the file `.gitea/issue_config.yaml` with the content `blank_issues_enabled` in the Repo.
* Make minio package support legacy MD5 checksum (#23768)wxiaoguang2023-03-281-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | A feedback from discord: https://discord.com/channels/322538954119184384/561007778139734027/1090185427115319386 Some storages like: * https://developers.cloudflare.com/r2/api/s3/api/ * https://www.backblaze.com/b2/docs/s3_compatible_api.html They do not support "x-amz-checksum-algorithm" header But minio recently uses that header with CRC32C by default. So we have to tell minio to use legacy MD5 checksum. I guess this needs to be backported because IIRC we 1.19 and 1.20 are using similar minio package. The minio package code for SendContentMD5 looks like this: <details> <img width="755" alt="image" src="https://user-images.githubusercontent.com/2114189/228186768-4f2f6f67-62b9-4aee-9251-5af714ad9674.png"> </details>
* Add Simplified Chinese translate for oauth2-provider (#23713)Akkariin Meiko2023-03-261-0/+139
|
* Fix codeblocks in the cheat sheet (#23664)Sandro2023-03-231-10/+10
|
* Restructure documentation. Now the documentation has installation, ↵Lunny Xiao2023-03-23120-344/+253
| | | | | | | | | | | | | | | | | | | | | | administration, usage, development, contributing the 5 main parts (#23629) - **Installation**: includes how to install Gitea and related other tools, also includes upgrade Gitea - **Administration**: includes how to configure Gitea, customize Gitea and manage Gitea instance out of Gitea admin UI - **Usage**: includes how to use Gitea's functionalities. A sub documentation is about packages, in future we could also include CI/CD and others. - **Development**: includes how to integrate with Gitea's API, how to develop new features within Gitea - **Contributing**: includes how to contribute code to Gitea repositories. After this is merged, I think we can have a sub-documentation of `Usage` part named `Actions` to describe how to use Gitea actions --------- Co-authored-by: John Olheiser <john.olheiser@gmail.com>
* Add extra features to product comparison (#23638)Tim2023-03-221-0/+3
| | | | | | | Add some review features that are notably missing from Gitlab CE but not Gitea. Also add Merge Queues which is not supported by Gitea but is quite an important feature.
* Update PR documentation (#23620)John Olheiser2023-03-211-1/+37
| | | | | | | | | This updates the PR docs and explains how to work with PRs, for those who may not know. It was mentioned that this page could explain PRs a bit better, in case some users are not familiar with GitHub or similar forges. Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Add `.patch` to `attachment.ALLOWED_TYPES` (#23580)silverwind2023-03-191-1/+1
|
* Move pidfile creation from setting to web cmd package (#23285)Lunny Xiao2023-03-161-1/+1
| | | | | | | | | | | | Creating pid file should not belong to setting package and only web command needs that. So this PR moves pidfile creation from setting package to web command package to keep setting package more readable. I marked this as `break` because the PIDFile path moved. For those who have used the pid build argument, it has to be changed. --------- Co-authored-by: KN4CK3R <admin@oldschoolhack.me>
* Replace Less with CSS (#23481)silverwind2023-03-142-3/+3
| | | | | | | | | | | | Ran most of the Less files through the Less compiler and Prettier and then followed up with a round of manual fixes. The Less compiler had unfortunately stripped all `//` style comments that I had to restore (It did preserve `/* */` comments). Other fixes include duplicate selector removal which were revealed after the transpilation and which weren't caught by stylelint before but now are. Fixes: https://github.com/go-gitea/gitea/issues/15565
* Update app.example.ini (#23480)Jordan Cech2023-03-141-1/+1
|
* Push option bonus for PTC docs (#23473)John Olheiser2023-03-143-2/+6
| | | | | | | | | Follow-up for #23458 I could have suggested this on the original PR, but I thought there would be more to add. Hadn't noticed the push options docs already had nearly the same shell command. 😅 Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Lint Markdown passtechknowlogick2023-03-141-1/+2
|
* Push to create docs (#23458)techknowlogick2023-03-141-0/+35
| | | | This PR adds user friendly documentation on how to use push to create feature
* fix markdown lint issue (#23457)techknowlogick2023-03-141-0/+2
| | | | | | | | | CI is failing with the following: ``` docs/content/doc/features/localization.zh-cn.md:16 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "# 本地化"] docs/content/doc/features/localization.zh-cn.md:23 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## 支持的语言"] ``` This fixes that error
* Update localization.zh-cn.md (#23448)LeenHawk2023-03-141-1/+13
| | | As title.
* Add Swift package registry (#22404)KN4CK3R2023-03-133-0/+95
| | | | | | This PR adds a [Swift](https://www.swift.org/) package registry. ![grafik](https://user-images.githubusercontent.com/1666336/211842523-07521cbd-8fb6-400f-820c-ee8048b05ae8.png)
* Support reflogs (#22451)Philip Peterson2023-03-131-0/+5
| | | | | | | | | | | This PR adds support for reflogs on all repositories. It does this by adding a global configuration entry. Implements #14865 --------- Signed-off-by: Philip Peterson <philip.c.peterson@gmail.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Scoped label display and documentation tweaks (#23430)Brecht Van Lommel2023-03-131-5/+3
| | | | | | | | | | | * Fix scoped label left and right part breaking across lines. * Remove slanted divider in scoped label display, make it straight. After using this for a while, this feels more visually noisy than helpful. * Reduce contrast between scope and item to reduce probability of unreadable text on background. * Change documentation to remove mention of non-exclusive scoped labels. Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Parse external request id from request headers, and print it in access log ↵sillyguodong2023-03-102-1/+22
| | | | | | | | | | | | | | | | | | | | | | | | | (#22906) Close: #22890. --- ### Configure in .ini file: ```ini [log] REQUEST_ID_HEADERS = X-Request-ID, X-Trace-Id ``` ### Params in Request Header ``` X-Trace-ID: trace-id-1q2w3e4r ``` ![image](https://user-images.githubusercontent.com/33891828/218665296-8fd19a0f-ada6-4236-8bdb-f99201c703e8.png) ### Log output: ![image](https://user-images.githubusercontent.com/33891828/218665225-cc242a57-4ffc-449a-a1f6-f45ded0ead60.png)
* Add user webhooks (#21563)KN4CK3R2023-03-101-0/+1
| | | | | | | Currently we can add webhooks for organizations but not for users. This PR adds the latter. You can access it from the current users settings. ![grafik](https://user-images.githubusercontent.com/1666336/197391408-15dfdc23-b476-4d0c-82f7-9bc9b065988f.png)
* Add gradle samples in maven doc of packages (#23374)InsanusMokrassar2023-03-091-1/+47
| | | | | | | | Samples for gitea.io docs to help to use maven packages with gradle-oriented projects --------- Co-authored-by: KN4CK3R <admin@oldschoolhack.me>
* Update documentation for the new YAML label file format (#23020)JonRB2023-03-071-1/+14
| | | | | | | | | | | | update documentation to include an overview of the yaml label template that is part of PR #22976 Signed-off-by: Jon Roadley-Battin <jon.roadleybattin@gmail.com> --------- Co-authored-by: Yarden Shoham <hrsi88@gmail.com> Co-authored-by: Lauris BH <lauris@nix.lv> Co-authored-by: John Olheiser <john.olheiser@gmail.com> Co-authored-by: delvh <dev.lh@web.de>
* Update hacking-on-gitea-zh_cn documentation (#23315)Lunny Xiao2023-03-061-14/+320
| | | | | | | This PR fix outdated hacking-on-gitea-zh_cn documentation. --------- Co-authored-by: Jason Song <i@wolfogre.com>
* Improve the frontend guideline (#23298)wxiaoguang2023-03-051-0/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | ### The CustomEvent prefix There was already `ce-quick-submit`, the `ce-` prefix seems better than `us-`. Rename the only `us-` prefixed `us-load-context-popup` to `ce-` prefixed. ### Styles and Attributes in Go HTML Template https://github.com/go-gitea/gitea/pull/21855#issuecomment-1429643073 Suggest to stick to `class="c1 {{if $var}}c2{{end}}"` The readability and maintainability should be applied to the code which is read by developers, but not for the generated outputs. The template code is the code for developers, while the generated HTML are only for browsers. The `class="c1 {{if $var}}c2{{end}}"` style is clearer for developers and more intuitive, and the generated HTML also makes browsers happy (a few spaces do not affect anything) Think about a more complex case: * `class="{{if $active}}active{{end}} menu item {{if $show}}show{{end}} {{if $warn}}warn{{end}}"` * --vs-- * `class="{{if $active}}active {{end}}menu item{{if $show}} show{{end}}{{if $warn}} warn{{end}}"` The first style make it clearer to see each CSS class name with its `{{if}}` block. Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Add basic documentation for labels, including scoped labels (#23304)Brecht Van Lommel2023-03-051-0/+42
| | | | | | | Part of #22974 --------- Co-authored-by: delvh <dev.lh@web.de>
* Re-add accidentally removed `hacking-on-gitea.zh-cn.md` (#23297)Lunny Xiao2023-03-041-0/+43
| | | | #21627 accidentally removed the docs file `hacking-on-gitea.zh-cn.md`. This re-adds it and merges some changes from #23289
* Improve frontend guideline (#23252)wxiaoguang2023-03-021-0/+3
| | | | | If an event listener must be `async`, the `e.preventDefault()` should be before any `await`, it's recommended to put it at the beginning of the function.
* Add InsecureSkipVerify to Minio Client for Storage (#23166)Yarden Shoham2023-02-272-0/+8
| | | | | | | Allows using Minio with untrusted certificates Closes #23128 Signed-off-by: Yarden Shoham <hrsi88@gmail.com>
* Fix secrets overview page missing from docs sidebar (#23143)Yarden Shoham2023-02-252-2/+2
| | | | | | | | | | | | | | | | There was a warning while building the docs: `Building sites … WARN 2023/02/25 08:56:37 "/workspace/gitea/docs/content/doc/secrets/overview.en-us.md:1:1": duplicate menu entry with identifier "overview" in menu "sidebar"`. ### Before ![image](https://user-images.githubusercontent.com/20454870/221348741-55cef254-f2ac-4507-9a66-818b406c668f.png) ### After ![image](https://user-images.githubusercontent.com/20454870/221348757-42066303-e1b7-43fe-9c4f-e05182fbabdd.png) Signed-off-by: Yarden Shoham <hrsi88@gmail.com>
* Avoid Hugo from adding quote to actions url (#23097)Sven2023-02-231-1/+1
|
* Nest metadata in refactoring docs (#23087)techknowlogick2023-02-231-5/+5
| | | | | Whitespace was missing from refactoring docs metadata. backport label applied so it is included in versioned docs.
* Improve reverse proxies documentation (#23068)Joakim Pettersen2023-02-231-0/+20
| | | | | | | Add "Traefik with a sub-path" documentation closes #23047 Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Add Bash and Zsh completion scripts (#22646)zeripath2023-02-212-0/+20
| | | | | | | | | | | | | | | | | | | | | | | This PR adds contrib scripts for bash and zsh completion. Simply call: ```bash source contrib/autocompletion/bash_autocomplete ``` or for Zsh: ```bash source contrib/autocompletion/zsh_autocomplete ``` Signed-off-by: Andrew Thornton <art27@cantab.net> --------- Signed-off-by: Andrew Thornton <art27@cantab.net> Co-authored-by: a1012112796 <1012112796@qq.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Improve frontend guidelines (#23007)wxiaoguang2023-02-211-5/+13
| | | Some were out-dated, some are added.
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-26 18:17:16 +0000