aboutsummaryrefslogtreecommitdiffstats
path: root/docs/content/doc/usage
Commit message (Collapse)AuthorAgeFilesLines
* Docusaurus-ify (#26051)John Olheiser2023-07-26101-10743/+0
| | | | | | | | | | | | | | This PR cleans up the docs in a way to make them simpler to ingest by our [docs repo](https://gitea.com/gitea/gitea-docusaurus). 1. It includes all of the sed invocations our ingestion did, removing the need to do it at build time. 2. It replaces the shortcode variable replacement method with `@variable@` style, simply for easier sed invocations when required. 3. It removes unused files and moves the docs up a level as cleanup. --------- Signed-off-by: jolheiser <john.olheiser@gmail.com>
* added ssh mirror workaround description (#26096)thigg2023-07-251-0/+13
| | | | | | related #1635 #18159 This will probably be obsolete at some point, but it should not break anything and it may help some users
* doc sync authentication.md to zh-cn (#26117)caicandong2023-07-251-1/+257
| | | as title
* doc guide the user to create the appropriate level runner (#26091)caicandong2023-07-245-9/+17
| | | close #26045
* Update secrets.en-us.md (#26057)JonRB2023-07-221-1/+1
| | | | Present documentation does not capture that secrets are only visible if ACTIONS are enabled for a repository. This PR adds a short note
* RPM Registry: Show zypper commands for SUSE based distros as well (#25981)Dominik Heidler2023-07-204-5/+5
| | | | | | | | | After RPM is supported with https://github.com/go-gitea/gitea/pull/23380 let's show the user how to add the repo and install the RPM via all common package managers. --------- Co-authored-by: Giteabot <teabot@gitea.io>
* Update blog links (#25843)HesterG2023-07-122-2/+2
| | | | | | | | As title. Permalinks for lastest version of blog has changed, update the blog links. --------- Co-authored-by: Giteabot <teabot@gitea.io>
* Add documentation about supported workflow trigger events (#25582)Zettat1232023-06-292-0/+40
| | | | | Right now Gitea doesn't support all [Events that trigger workflows](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows). This PR lists the supported events to help users write workflow files.
* Substitute variables in path names of template repos too (#25294)Kyle D2023-06-201-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | ### Summary Extend the template variable substitution to replace file paths. This can be helpful for setting up log files & directories that should match the repository name. ### PR Changes - Move files matching glob pattern when setting up repos from template - For security, added ~escaping~ sanitization for cross-platform support and to prevent directory traversal (thanks @silverwind for the reference) - Added unit testing for escaping function - Fixed the integration tests for repo template generation by passing the repo_template_id - Updated the integration testfiles to add some variable substitution & assert the outputs I had to fix the existing repo template integration test and extend it to add a check for variable substitutions. Example: ![image](https://github.com/go-gitea/gitea/assets/12700993/621feb09-0ef3-460e-afa8-da74cd84fa4e)
* Docs about how to generate config for act runner with docker and setup it ↵Zisu Zhang2023-06-162-0/+54
| | | | | | | | | | with docker-compose (#25256) In this pull request, the following changes are addressed: - State user should create `config.yaml` before start container to avoid errors. - Provided instructions to deploy runners using docker compose.
* Add codeowners feature (#24910)Vladimir Buyanov2023-06-081-0/+65
| | | | | | Hello. This PR adds a github like configuration for the CODEOWNERS file. Resolves: #10161
* change placeholders in actions docstechknowlogick2023-06-051-1/+1
|
* change placeholders in actions docstechknowlogick2023-06-051-1/+1
|
* Introduce how to configure cache when starting a Runner with Docker (#25077)sillyguodong2023-06-052-0/+67
| | | | | | | If a user starts a runner using a Docker image without making additional configurations, the [cache action](https://github.com/actions/cache) will not work properly. Therefore, add a section in the documentation that explains how to configure the cache correctly.
* improve permission documentation (#23942)Lunny Xiao2023-06-051-9/+24
|
* Fix link to customizing-gitea (#25056)kodermho2023-06-032-2/+2
| | | | The link to customizing-gitea in the label documentation is broken. This PR should adjust the relative path to fix the link
* Add chinese documentations for `cran package registry` (#25012)sillyguodong2023-05-311-0/+93
| | | As title.
* simple docs fixes: 'pull request' page (en-us & zh-tw) link path to ↵Jon Keim2023-05-282-2/+2
| | | | | 'issue-pull-request-templates' (#24961) Co-authored-by: silverwind <me@silverwind.io>
* Fix documentation ref (#24934)Lunny Xiao2023-05-264-26/+26
| | | Fix documentation ref
* Add Chinese documentations for Actions (#24902)HesterG2023-05-2512-6/+877
|
* `zh-cn` translation for usage docs (#24897)Zettat1232023-05-2514-6/+988
|
* Add chinese documentations for `Packages` (#24914)sillyguodong2023-05-2526-9/+2395
|
* Rename docs packages title from xxx Packages Repository -> xxx Package ↵Lunny Xiao2023-05-2419-38/+38
| | | | | Registry (#24895) As title.
* Remove unnecessary usage prefix from doc titles (#24869)Lunny Xiao2023-05-234-11/+11
| | | As title.
* Add CRAN package registry (#22331)KN4CK3R2023-05-222-0/+94
| | | | | This PR adds a [CRAN](https://cran.r-project.org/) package registry. ![grafik](https://user-images.githubusercontent.com/1666336/210450039-d6fa6f77-20cd-4741-89a8-1624def267f7.png)
* Merge message template support for rebase without merge commit (#22669)Brecht Van Lommel2023-05-221-0/+7
| | | | | | | | | | | | Use `default_merge_message/REBASE_TEMPLATE.md` for amending the message of the last commit in the list of commits that was merged. Previously this template was mentioned in the documentation but not actually used. In this template additional variables `CommitTitle` and `CommitBody` are available, for the title and body of the commit. Ideally the message of every commit would be updated using the template, but doing an interactive rebase or merging commits one by one is complicated, so that is left as a future improvement.
* Updates to doc (#24757)Alejandro Leal2023-05-172-3/+3
| | | | | | | | | | | ## Misspelling fixes to: - docs/content/doc/administration/config-cheat-sheet.en-us.md - docs/content/doc/installation/from-source.en-us.md - docs/content/doc/usage/packages/cargo.en-us.md - docs/content/doc/usage/packages/storage.en-us.md --------- Co-authored-by: delvh <dev.lh@web.de>
* Update packages overview page (#24730)Yevhen Pavlov2023-05-151-0/+1
| | | Add missed Go package reference to packages overview page
* Move actions as usage's subdirectory and update comparsion zh-cn version ↵Lunny Xiao2023-05-156-0/+874
| | | | | | | (#24719) As title. Co-authored-by: Giteabot <teabot@gitea.io>
* Add Go package registry (#24687)KN4CK3R2023-05-144-8/+85
| | | | | | | Fixes #7608 This PR adds a Go package registry usable with the Go proxy protocol. ![grafik](https://github.com/go-gitea/gitea/assets/1666336/328feb5c-3df2-4f9d-8eae-fe3126d14c37)
* Add Alpine package registry (#23714)KN4CK3R2023-05-123-1/+135
| | | | | | | | | | | | | | | | | | This PR adds an Alpine package registry. You can follow [this tutorial](https://wiki.alpinelinux.org/wiki/Creating_an_Alpine_package) to build a *.apk package for testing. This functionality is similar to the Debian registry (#22854) and therefore shares some methods. I marked this PR as blocked because it should be merged after #22854. ![grafik](https://user-images.githubusercontent.com/1666336/227779595-b76163aa-eea1-4a79-9583-775c24ad74e8.png) --------- Co-authored-by: techknowlogick <techknowlogick@gitea.io> Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: Giteabot <teabot@gitea.io>
* Fix typo in the swift package documentation (#24637)ericLemanissier2023-05-101-1/+1
|
* Fix broken links in documents (#24630)Jason Song2023-05-101-1/+1
| | | | | | | | | | | Before: <img width="837" alt="image" src="https://github.com/go-gitea/gitea/assets/9418365/90c1c484-2d8d-4a57-8e86-2f4df0e7fbba"> After: <img width="822" alt="image" src="https://github.com/go-gitea/gitea/assets/9418365/e27f6b63-9e7b-4894-b315-7be0cfebe8ca">
* Add Gitea Profile Readmes (#23260)Nicholas Pease2023-05-091-0/+20
| | | | | | | | | | | | | | | | | | | | | | | | | Implements displaying a README.md file present in a users ```.profile``` repository on the users profile page. If no such repository/file is present, the user's profile page remains unchanged. Example of user with ```.profile/README.md``` ![image](https://user-images.githubusercontent.com/34464552/222757202-5d53ac62-60d9-432f-b9e3-2537ffa91041.png) Example of user without ```.profile/README.md``` ![image](https://user-images.githubusercontent.com/34464552/222759972-576e058b-acd4-47ac-be33-38a7cb58cc81.png) This pull request closes the feature request in #12233 Special thanks to @techknowlogick for the help in the Gitea discord! --------- Co-authored-by: techknowlogick <techknowlogick@gitea.io> Co-authored-by: Yarden Shoham <hrsi88@gmail.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: yp05327 <576951401@qq.com> Co-authored-by: Yarden Shoham <git@yardenshoham.com>
* Fix docs failing the build on `main` (#24561)Yarden Shoham2023-05-061-2/+2
| | | | | | | | Regression from https://github.com/go-gitea/gitea/pull/23380 First failing build: https://drone.gitea.io/go-gitea/gitea/74565 https://github.com/go-gitea/gitea/actions/runs/4897332409/jobs/8745242395 Signed-off-by: Yarden Shoham <git@yardenshoham.com>
* Add RPM registry (#23380)KN4CK3R2023-05-052-0/+119
| | | | | | | | | | | | | | | Fixes #20751 This PR adds a RPM package registry. You can follow [this tutorial](https://opensource.com/article/18/9/how-build-rpm-packages) to build a *.rpm package for testing. This functionality is similar to the Debian registry (#22854) and therefore shares some methods. I marked this PR as blocked because it should be merged after #22854. ![grafik](https://user-images.githubusercontent.com/1666336/223806549-d8784fd9-9d79-46a2-9ae2-f038594f636a.png)
* Docs for Gitea Actions (#24405)Jason Song2023-05-051-1/+1
| | | | | | | | | | | | | | | | | A new documentation section for Gitea Actions. Some content comes from: - [Hacking on Gitea Actions](https://blog.gitea.io/2023/03/hacking-on-gitea-actions/) - The README of [act_runner](https://gitea.com/gitea/act_runner) - @ChristopherHX's excellent overview of the differences between Gitea Actions and GitHub Actions in [this comment](https://github.com/go-gitea/gitea/issues/13539#issuecomment-1448888850). --------- Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Update LDAP filters to include both username and email address (#24547)Gary Moon2023-05-051-5/+5
| | | | | | | Since the login form label for user_name unconditionally displays `Username or Email Address` for the `user_name` field, bring matching LDAP filters to more prominence in the documentation/placeholders. Signed-off-by: Gary Moon <gary@garymoon.net>
* Add Debian package registry (#24426)KN4CK3R2023-05-022-0/+135
| | | | | | | | | | | | | | | | | | | | | | | | Co-authored-by: @awkwardbunny This PR adds a Debian package registry. You can follow [this tutorial](https://www.baeldung.com/linux/create-debian-package) to build a *.deb package for testing. Source packages are not supported at the moment and I did not find documentation of the architecture "all" and how these packages should be treated. ![grafik](https://user-images.githubusercontent.com/1666336/218126879-eb80a866-775c-4c8e-8529-5797203a64e6.png) Part of #20751. Revised copy of #22854. --------- Co-authored-by: Brian Hong <brian@hongs.me> Co-authored-by: techknowlogick <techknowlogick@gitea.io> Co-authored-by: Giteabot <teabot@gitea.io>
* Replace `N/A` with `-` everywhere (#24474)silverwind2023-05-021-18/+18
| | | | | | | | | | | | | | Followup to https://github.com/go-gitea/gitea/pull/24427. Reasoning is that `N/A` is specific to english while `-` is language-neutral and does not need translation. Before: <img width="891" alt="Screenshot 2023-05-01 at 20 58 20" src="https://user-images.githubusercontent.com/115237/235511592-8a36d0f2-34ff-4dbe-b642-67c0ade644fe.png"> After: <img width="901" alt="Screenshot 2023-05-01 at 20 59 59" src="https://user-images.githubusercontent.com/115237/235511594-d49f6d09-92e8-4e99-be7b-2a37f5d24129.png">
* Revert "Add Debian package registry" (#24412)Yarden Shoham2023-04-282-135/+0
| | | Reverts go-gitea/gitea#22854
* Add Debian package registry (#22854)KN4CK3R2023-04-282-0/+135
| | | | | | | | | | | | | | Co-authored-by: @awkwardbunny This PR adds a Debian package registry. You can follow [this tutorial](https://www.baeldung.com/linux/create-debian-package) to build a *.deb package for testing. Source packages are not supported at the moment and I did not find documentation of the architecture "all" and how these packages should be treated. --------- Co-authored-by: Brian Hong <brian@hongs.me> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Refactor docs (#23752)John Olheiser2023-04-2846-1/+1974
| | | | | | | | | | | | | | | | | | | | | | | | | | | This was intended to be a small followup for https://github.com/go-gitea/gitea/pull/23712, but...here we are. 1. Our docs currently use `slug` as the entire URL, which makes refactoring tricky (see https://github.com/go-gitea/gitea/pull/23712). Instead, this PR attempts to make future refactoring easier by using slugs as an extension of the section. (Hugo terminology) - What the above boils down to is this PR attempts to use directory organization as URL management. e.g. `usage/comparison.en-us.md` -> `en-us/usage/comparison/`, `usage/packages/overview.en-us.md` -> `en-us/usage/packages/overview/` - Technically we could even remove `slug`, as Hugo defaults to using filename, however at least with this PR it means `slug` only needs to be the name for the **current file** rather than an entire URL 2. This PR adds appropriate aliases (redirects) for pages, so anything on the internet that links to our docs should hopefully not break. 3. A minor nit I've had for a while, renaming `seek-help` to `support`. It's a minor thing, but `seek-help` has a strange connotation to it. 4. The commits are split such that you can review the first which is the "actual" change, and the second is added redirects so that the first doesn't break links elsewhere. --------- Signed-off-by: jolheiser <john.olheiser@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-0610-10/+10
| | | As title.
* Update docs markdown file weight to make it clear (#23909)Lunny Xiao2023-04-045-4/+6
| | | | For Docusaurus, it needs a meta data named `sidebar_position`, so we copy all `weight` under `menu/sidebar` as top meta key.
* 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.
* Restructure documentation. Now the documentation has installation, ↵Lunny Xiao2023-03-2323-1821/+1041
| | | | | | | | | | | | | | | | | | | | | | 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>
* 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>
* 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>
generated by cgit v1.2.3 (git 2.39.1) at 2025-01-14 17:08:24 +0000