aboutsummaryrefslogtreecommitdiffstats
path: root/docs/content/usage
Commit message (Collapse)AuthorAgeFilesLines
* Remove docs sub folder since docs has been moved to ↵Lunny Xiao2024-07-10102-10564/+0
| | | | https://gitea.com/gitea/docs (#31536)
* Allow including `Reviewed-on`/`Reviewed-by` lines for custom merge messages ↵Max Wipfli2024-06-061-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | (#31211) This PR introduces the `ReviewedOn` and `ReviewedBy` variables for the default merge message templates (e.g., `.gitea/default_merge_message/MERGE_TEMPLATE.md`). This allows customizing the default merge messages while retaining these trailers. This also moves the associated logic out of `pull.tmpl` into the relevant Go function. This is a first contribution towards #11077. --- For illustration, this allows to recreate the "default default" merge message with the following template: ``` .gitea/default_merge_message/MERGE_TEMPLATE.md Merge pull request '${PullRequestTitle}' (${PullRequestReference}) from ${HeadBranch} into ${BaseBranch} ${ReviewedOn} ${ReviewedBy} ```
* Fix URL In Gitea Actions Badge Docs (#31191)TheBrokenRail2024-05-311-1/+1
| | | | | | | | | | | | | | | | The example URL given in the documentation leads to a 404. For instance, `https://your-gitea-instance.com/{owner}/{repo}/actions/workflows/{workflow_file}?branch={branch}&event={event}` translates to `https://gitea.thebrokenrail.com/minecraft-pi-reborn/minecraft-pi-reborn/actions/workflows/build.yml`, which is a 404. I had to check the [linked GitHub docs](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge) to learn that you have to add `/badge.svg` to the URL. Example: https://gitea.thebrokenrail.com/minecraft-pi-reborn/minecraft-pi-reborn/actions/workflows/build.yml/badge.svg
* Update demo site location from try.gitea.io -> demo.gitea.com (#31054)Lunny Xiao2024-05-273-3/+3
|
* Move documents under actions (#31110)Lunny Xiao2024-05-273-9/+3
| | | Move secrets and badge under actions
* Rename project board -> column to make the UI less confusing (#30170)Lunny Xiao2024-05-271-1/+1
| | | | | | | | | | | | | This PR split the `Board` into two parts. One is the struct has been renamed to `Column` and the second we have a `Template Type`. But to make it easier to review, this PR will not change the database schemas, they are just renames. The database schema changes could be in future PRs. --------- Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: yp05327 <576951401@qq.com>
* Update Actions documentation missing feature (#31034)Lunny Xiao2024-05-222-0/+8
| | | | | | | | | Fix https://github.com/go-gitea/gitea/issues/25897#issuecomment-2117145391 --------- Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: yp05327 <576951401@qq.com>
* fix: change npm scope registry (#30964)james yang2024-05-132-4/+4
| | | https://docs.npmjs.com/cli/v10/using-npm/scope#associating-a-scope-with-a-registry
* Gitea with first upper case + typos (#30739)mainboarder2024-04-281-4/+4
| | | | * Corrected gitea to Gitea * fixed some typos
* Update actions variables documents (#30394)Lunny Xiao2024-04-114-60/+80
| | | | | | | | Fix #30393 --------- Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: Zettat123 <zettat123@gmail.com>
* Fix actions design about default actions download url (#30360)Lunny Xiao2024-04-092-2/+3
| | | Fix #30359
* Add user blocking (#29028)KN4CK3R2024-03-041-0/+56
| | | | | | | | | | | | | | | | | | | | | | Fixes #17453 This PR adds the abbility to block a user from a personal account or organization to restrict how the blocked user can interact with the blocker. The docs explain what's the consequence of blocking a user. Screenshots: ![grafik](https://github.com/go-gitea/gitea/assets/1666336/4ed884f3-e06a-4862-afd3-3b8aa2488dc6) ![grafik](https://github.com/go-gitea/gitea/assets/1666336/ae6d4981-f252-4f50-a429-04f0f9f1cdf1) ![grafik](https://github.com/go-gitea/gitea/assets/1666336/ca153599-5b0f-4b4a-90fe-18bdfd6f0b6b) --------- Co-authored-by: Lauris BH <lauris@nix.lv>
* Extend issue template yaml engine (#29274)65432024-03-041-15/+37
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add new option: `visible`: witch can hide a specific field of the form or the created content afterwards It is a string array witch can contain `form` and `content`. If only `form` is present, it wont show up in the created issue afterwards and the other way around. By default it sets both except for markdown As they are optional and github don't have any similar thing, it is non breaking and also do not conflict with it. With this you can: - define "post issue creation" elements like a TODO list to track an issue state - make sure to have a checkbox that reminds the user to check for a thing but dont have it in the created issue afterwards - define markdown for the created issue (was the downside of using yaml instead of md in the past) - ... ## Demo ```yaml name: New Contribution description: External Contributor creating a pull body: - type: checkboxes id: extern-todo visible: [form] attributes: label: Contribution Guidelines options: - label: I checked there exist no similar feature to be extended required: true - label: I did read the CONTRIBUTION.MD required: true - type: checkboxes id: intern-todo visible: [content] attributes: label: Maintainer Check-List options: - label: Does this pull follow the KISS principe - label: Checked if internal bord was notifyed # .... ``` [Demo Video](https://cloud.obermui.de/s/tm34fSAbJp9qw9z/download/vid-20240220-152751.mkv) --- *Sponsored by Kithara Software GmbH* --------- Co-authored-by: John Olheiser <john.olheiser@gmail.com> Co-authored-by: delvh <dev.lh@web.de>
* Implement actions badge svgs (#28102)Nanguan Lin2024-02-271-0/+37
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | replace #27187 close #23688 The badge has two parts: label(workflow name) and message(action status). 5 colors are provided with 7 statuses. Color mapping: ```go var statusColorMap = map[actions_model.Status]string{ actions_model.StatusSuccess: "#4c1", // Green actions_model.StatusSkipped: "#dfb317", // Yellow actions_model.StatusUnknown: "#97ca00", // Light Green actions_model.StatusFailure: "#e05d44", // Red actions_model.StatusCancelled: "#fe7d37", // Orange actions_model.StatusWaiting: "#dfb317", // Yellow actions_model.StatusRunning: "#dfb317", // Yellow actions_model.StatusBlocked: "#dfb317", // Yellow } ``` preview: ![1](https://github.com/go-gitea/gitea/assets/70063547/5465cbaf-23cd-4437-9848-2738c3cb8985) ![2](https://github.com/go-gitea/gitea/assets/70063547/ec393d26-c6e6-4d38-b72c-51f2494c5e71) ![3](https://github.com/go-gitea/gitea/assets/70063547/3edb4fdf-1b08-4a02-ab2a-6bdd7f532fb2) ![4](https://github.com/go-gitea/gitea/assets/70063547/8c189de2-2169-4251-b115-0e39a52f3df8) ![5](https://github.com/go-gitea/gitea/assets/70063547/3fe22c73-c2d7-4fec-9ea4-c501a1e4e3bd) --------- Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: Giteabot <teabot@gitea.io> Co-authored-by: delvh <dev.lh@web.de>
* Update docs about `DEFAULT_ACTIONS_URL` (#29442)Jason Song2024-02-272-16/+15
| | | Follow #25581.
* Revert "Support SAML authentication (#25165)" (#29358)65432024-02-241-69/+0
| | | | | | | | | | This reverts #25165 (5bb8d1924d77c675467694de26697b876d709a17), as there was a chance some important reviews got missed. so after reverting this patch it will be resubmitted for reviewing again https://github.com/go-gitea/gitea/pull/25165#issuecomment-1960670242 temporary Open #5512 again
* Support SAML authentication (#25165)techknowlogick2024-02-231-0/+69
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Closes https://github.com/go-gitea/gitea/issues/5512 This PR adds basic SAML support - Adds SAML 2.0 as an auth source - Adds SAML configuration documentation - Adds integration test: - Use bare-bones SAML IdP to test protocol flow and test account is linked successfully (only runs on Postgres by default) - Adds documentation for configuring and running SAML integration test locally Future PRs: - Support group mapping - Support auto-registration (account linking) Co-Authored-By: @jackHay22 --------- Co-authored-by: jackHay22 <jack@allspice.io> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: KN4CK3R <admin@oldschoolhack.me> Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: Jason Song <i@wolfogre.com> Co-authored-by: morphelinho <morphelinho@users.noreply.github.com> Co-authored-by: Zettat123 <zettat123@gmail.com> Co-authored-by: Yarden Shoham <git@yardenshoham.com> Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: silverwind <me@silverwind.io>
* Explained where create issue/PR template (#29035) (#29266)65432024-02-201-1/+2
| | | | | | | | | | | | | | | For some user (as me), documentation lack of precision about where to store issue/pr template. I propose an enhancement about this point. With bold exergue and precision about server itself. I've found some user with same interrogation as : https://forum.gitea.com/t/issue-template-directory/3328 --------- Co-authored-by: Km <cam.lafit@azerttyu.net> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* Update docs for actions variables (#29239)zhangnew2024-02-181-6/+0
| | | | the variables is supported, see https://github.com/go-gitea/gitea/blob/a784ed3d6c6946fd9bf95f2e910f52f549326fe2/docs/content/usage/actions/act-runner.zh-cn.md?plain=1#L262-L289
* Docker Tag Information in Docs (#29047)wienans2024-02-161-0/+10
| | | | | | | | Add more details for the docker tag when using container registry. --------- Co-authored-by: wxiaoguang <wxiaoguang@gmail.com> Co-authored-by: KN4CK3R <admin@oldschoolhack.me>
* Runner tokens are multi use (#29153)Scott Yeager2024-02-142-2/+4
| | | | | Fixes https://github.com/go-gitea/gitea/issues/28911. Co-authored-by: Giteabot <teabot@gitea.io>
* Update some translations and fix markdown formatting (#29099)me2seeks2024-02-111-1/+5
| | | | | | | | | Update `docs/content/administration/backup-and-restore.zh-cn.md` `docs/content/contributing/guidelines-frontend.zh-cn.md` `docs/content/help/support.zh-cn.md` `docs/content/installation/database-preparation.zh-cn.md` `docs/content/installation/windows-service.zh-cn.md` `docs/content/usage/profile-readme.zh-cn.md` to be consistent with the English document
* Fix incorrect link to swift doc and swift package-registry login command ↵CEnnis912024-02-082-2/+3
| | | | | | | | | | | (#29096) Fixes a few mistakes in the Swift package registry documentation. Syntax for the `package-registry login` command can be found [here](https://github.com/apple/swift-package-manager/blob/main/Documentation/PackageRegistry/PackageRegistryUsage.md#registry-authentication). I was not sure the best way to compress all of that information, so I just focused on making sure the incorrect `package-registry set` command was fixed.
* Fix typos in the documentation (#29048)Wang2024-02-051-1/+1
| | | Corrected two typos.
* Update JS and PY dependencies, build for `es2020` browsers (#28977)silverwind2024-02-021-1/+1
| | | | | | | | | - Update all JS dependencies minus @mcaptcha/vanilla-glue - Fix new lint errors - Regenerate SVGs - Switch to maintained stylelint stylistic plugin - Tested Mermaid, Citation, Swagger, sorting - Raise ESBuild target to `es2020` as dictated by `pretty-ms` dependency.
* Fix doc img path in profile readme (#28994)yp053272024-01-312-1/+1
| | | https://gitea.com/gitea/gitea-docusaurus/actions/runs/1007/jobs/0#jobstep-9-25
* Add screenshot for "Profile Readmes" to docs (#28964)65432024-01-282-0/+4
| | | | | | introduced in #23260 ... the docs still looks to empty: https://docs.gitea.com/usage/profile-readme this changes it :)
* Fix some RPM registry flaws (#28782)KN4CK3R2024-01-191-14/+35
| | | | | | | | | | | | | | | | | | | Related #26984 (https://github.com/go-gitea/gitea/pull/26984#issuecomment-1889588912) Fix admin cleanup message. Fix models `Get` not respecting default values. Rebuild RPM repository files after cleanup. Do not add RPM group to package version name. Force stable sorting of Alpine/Debian/RPM repository data. Fix missing deferred `Close`. Add tests for multiple RPM groups. Removed non-cached `ReplaceAllStringRegex`. If there are multiple groups available, it's stated in the package installation screen: ![grafik](https://github.com/go-gitea/gitea/assets/1666336/8f132760-882c-4ab8-9678-77e47dfc4415)
* Support for grouping RPMs using paths (#26984)Exploding Dragon2024-01-122-26/+32
| | | | | | | | | | | | The current rpm repository places all packages in the same repository, and different systems (el7,f34) may hit packages that do not belong to this distribution ( #25304 ) , which now supports grouping of rpm. ![图片](https://github.com/go-gitea/gitea/assets/33776693/d1e1d99f-7799-4b2b-a19b-cb2a5c692914) Fixes #25304 . Fixes #27056 . Refactor: [#25866](https://github.com/go-gitea/gitea/pull/25866)
* switch destination directory for apt signing keys (#28639)Denys Konovalov2023-12-282-6/+6
| | | | | | | | | | | | | | | According to [Debian docs](https://wiki.debian.org/DebianRepository/UseThirdParty): > The certificate MUST NOT be placed in /etc/apt/trusted.gpg.d or loaded by apt-key add. > ... > If future updates to the certificate will be managed by an apt/dpkg package as recommended below, then it SHOULD be downloaded into /usr/share/keyrings using the same filename that will be provided by the package. If it will be managed locally , it SHOULD be downloaded into /etc/apt/keyrings instead. > ... > A sources.list entry SHOULD have the signed-by option set.
* Update repo-mirror.en-us.md (#28612)Volodymyr Stelmashchuk2023-12-271-1/+1
| | | | | Add small changes to the doc. The workflow scope require for push code to github mirror in case the project use the github action compatibility ui.
* feat: bump `dessant/lock-threads` and `actions/setup-go` to use nodejs20 ↵Rui Chen2023-12-2110-21/+21
| | | | | | | | | | | | | | runtime (#28565) Update more actions to use nodejs20 runtime and also update the docs for checkout action usage. similar to: - #27836 - #27096 --------- Signed-off-by: Rui Chen <rui@chenrui.dev>
* Update actions document about comparsion as Github Actions (#28560)Lunny Xiao2023-12-202-0/+16
|
* docs: Update group membership fields to match application. (#28175)David Hulick2023-12-131-9/+9
| | | | | | | | Several fields in the "Verify group membership in LDAP" docs were confusingly titled when compared to the actual fields in the application, this change rectifies that by matching the docs to the fields already present in gitea. Signed-off-by: David Hulick <dave.hulick@gmail.com>
* Fix links in docs (#28234)yp053272023-11-272-2/+2
| | | | | | | | | Follow #28191 Changes: - `(doc/administration/config-cheat-sheet.md` is incorrect: ![image](https://github.com/go-gitea/gitea/assets/18380374/1c417dd7-61a0-49ba-8d50-871fd4c9bf20) - remove `../../`
* Fix some incorrect links in docs (#28191)yp053272023-11-244-4/+4
| | | | | | | | | https://gitea.com/gitea/gitea-docusaurus/actions/runs/661/jobs/0#jobstep-9-39 I noticed that there are many warning logs in building docs. It is causing 404 in docs.gitea.com now, so we need to fix it. And there are also some other problems in v1.19 which can not be done in this PR. ps: Are there any good methods to test this in local?
* Fix the description about the default setting for action in quick start ↵yp053272023-11-222-2/+2
| | | | | | | | document (#28160) Since #27054, Actions are enabled by default. so we should also edit the document. 😃 ps: I think this should be backport to 1.21.0.
* Update docs for docusaurus v3 (#28125)John Olheiser2023-11-201-2/+2
| | | | | Updates the docs for usage with docusaurus v3 Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Add Profile Readme for Organisations (#27955)65432023-11-091-1/+2
| | | | | | | | | | | | | | | | | https://blog.gitea.com/release-of-1.20.0/#-user-profile-readme-23260 (#23260) did introduce Profile Readme for Users. This makes it usable for Organisations: ![image](https://github.com/go-gitea/gitea/assets/24977596/464ab58b-a952-414b-8a34-6deaeb4f7d35) --- *Sponsored by Kithara Software GmbH* --------- Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: KN4CK3R <admin@oldschoolhack.me>
* Remove `known issue` section in Gitea Actions Doc (#27930)Nanguan Lin2023-11-062-62/+0
| | | | | | | The bug has been fixed for several months in the `docker/build-push-action` The fix commit is [d8823bfaed](https://github.com/docker/build-push-action/commit/d8823bfaed2a82c6f5d4799a2f8e86173c461aba) as the Gitea Actions Doc mentioned too.
* doc: actions/act-runner: document running as a systemd service (#27844)nodiscc2023-11-011-0/+34
| | | | This documents running `act-runner` as a systemd service under a dedicated user account.
* Fix wrong relative path on obtain token from command line (#27850)Lunny Xiao2023-10-302-1/+3
| | | Caused by #27845
* doc: actions/act-runner: document obtaining a runner registration token from ↵nodiscc2023-10-301-0/+6
| | | | gitea CLI (#27845)
* Fix an indentation in the Chinese documentation of Act Runner (#27730)HoshinoRei2023-10-221-6/+6
| | | | | | In the [English document](https://docs.gitea.com/1.21/usage/actions/act-runner#configuring-cache-when-starting-a-runner-using-docker-image), there is indentation here, but there is no indentation in the Chinese document.
* Update agit-support.en-us.md (#27652)Sandro Santilli2023-10-171-6/+9
| | | | | Clarify Agit PR creation documentation See https://github.com/go-gitea/gitea/issues/27579
* Change the default branch in the agit docs (#27621)Nanguan Lin2023-10-142-6/+6
|
* rm outdated docs from some languages (#27530)techknowlogick2023-10-135-311/+0
| | | related to #27499
* Fix the wrong HTTP response status code for duplicate packages (#27480)Nanguan Lin2023-10-109-3/+49
| | | | | | | | fix #27470 (hope there is nothing missing 😢 ) --------- Co-authored-by: KN4CK3R <admin@oldschoolhack.me>
* Rephrase template documentation to be more clear about .gitea/template (#27450)Andrew Imeson2023-10-061-5/+8
| | | | | | | Closes #27336 --------- Co-authored-by: silverwind <me@silverwind.io>
* Fix incorrect Chinese translation of linked-references.zh-cn.md (#27382)Ayaka2023-10-021-1/+1
| | | | | | --- The original text "To address this" should be translated to "为了解决这个问题". "工单" looks like corresponds to "issue".