gitea/gitea-docs
1
0
Fork 0
mirror of https://gitea.com/gitea/docs.git synced 2026-06-30 16:14:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
959 Commits 5 Branches 5 Tags
fcb1d63349c49bd909ca9e86b8837be1fd01010c
Commit Graph

166 Commits

Author SHA1 Message Date
Giteabot
fcb1d63349 Update from-binary.en-us.md (#24975) (#24999) 
Backport #24975 by @team-epk

Fixed link to the creating a systemd service in Ubuntu document.
 2023-05-30 14:01:06 +08:00
Giteabot
3b5d7f8d06 Update documentation to explain which projects allow Gitea to host static pages (#23993) (#24058) 
Backport #23993 by @6543

close  #23521

Signed-off-by: 6543 <6543@obermui.de>
Co-authored-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>
 2023-04-11 18:43:35 +02:00
Lunny Xiao
a8a999a709 Update docs markdown file weight to make it clear (#23909) (#23921) 
backport #23909
 2023-04-04 11:27:38 -04:00
Lunny Xiao
a6ff89b930 Rename develop -> development, contribute -> contributing, administer -> administration (#23662) 
backport #23629 

To make versioned documentation less surprising, 1.19 should have the
same technology.
 2023-03-23 15:44:09 -05:00
zeripath
99f54b2056 Add Bash and Zsh completion scripts (#22646) 
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>
 2023-02-21 12:32:24 -05:00
Xinyu Zhou
bfaaf844ae docs: Update translation from-binary.zh-cn.md (#22820) 
Signed-off-by: Xinyu Zhou <i@sourcehut.net>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
 2023-02-13 13:14:51 +08:00
Peyton Duncan
4616bf51ef Grammar fix (#22790) 
Noticed a minor grammatical error.
 2023-02-06 16:05:59 -06:00
JonRB
9477670059 Add Gentoo to the from package providers (#22284) 
Signed-off-by: Jonathan Roadley-Battin <jon.roadleybattin@gmail.com>
 2022-12-30 11:14:51 -06:00
Dan Church
a120a6e886 Fix misc whitespace issues in install docs (#22189) 
I ran into issues when copy-pasting the docker-compose.yml contents from
https://docs.gitea.io/en-us/install-with-docker/ - specifically the part
about adding PostgreSQL to the YAML file; I tried manually adding the
diffs by removing the `+` at the beginning of lines, and the resulting
YAML was unparsable.

This forces the indentation to be consistent across all places where
YAML is used.

Co-authored-by: techknowlogick <techknowlogick@gitea.io>
 2022-12-20 17:26:03 -05:00
Yakov5776
e56db56aa8 Fix markdown typo of an extra backtick in docs (#22123) 
Fixes a visual bug in docs which is caused by a typo of an extra backtick.
 2022-12-13 18:20:36 -06:00
Xinyu Zhou
a15a7b1dc3 Improve docker rootless documentation (#21913) 
Emphasize folder creation/permission granting

Signed-off-by: Xinyu Zhou <i@sourcehut.net>

Signed-off-by: Xinyu Zhou <i@sourcehut.net>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
 2022-11-23 13:01:38 -05:00
wxiaoguang
cdcdf29bb4 Fix "build from source" document to clarify the bindata tag is required. (#21853) 2022-11-18 14:34:39 +08:00
zeripath
32d58714e1 Attempt clarify AppWorkPath etc. (#21656) 
Attempt clarify the AppWorkPath in the documentation by using different
notation and adding a section to the start of the cheat sheet.

Fix #21523

Signed-off-by: Andrew Thornton <art27@cantab.net>

Signed-off-by: Andrew Thornton <art27@cantab.net>
 2022-11-09 20:22:31 -05:00
Xinyu Zhou
a992da6bc7 Fix typo (#21695) 
Duplicate parentheses written in link.

Signed-off-by: Xinyu Zhou <i@sourcehut.net>
Co-authored-by: Lauris BH <lauris@nix.lv>
 2022-11-07 09:48:46 +08:00
Xinyu Zhou
b2ac814dc1 Fix docs relref (#21685) 
reslove
https://github.com/go-gitea/gitea/issues/21627#issuecomment-1303678781
 2022-11-04 17:55:25 -04:00
Xinyu Zhou
4756534dba Refactor docs (#21627) 
This patch:
- Rename some files( `.md` to `.en-us.md`), fix missed translation copy
- Update link which shoud be refer to `../hacking-on-gitea/` instead of
`../make/` (outdated)
- Update `_redirects`:
  -  redirect `/{zh-cn|fr-fr}/make/` to `../hacking-on-gitea/`
  - redirect `/zh-cn/third-party-tools/` to `/zh-cn/integrations/`
- Delete duplicated/outdated files.
- Update menu `weight` of developers.zh-cn.md

Signed-off-by: Xinyu Zhou <i@sourcehut.net>
 2022-10-31 23:16:19 +00:00
RainboWu
b0512452c3 Update macOS install command (#21507) 
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
 2022-10-19 21:30:21 -04:00
John Olheiser
a7f964c118 Make app.ini read-only message more prominent (#21315) 2022-10-02 04:12:59 -04:00
luzpaz
1a9c544d2e Fix various typos (#21103) 
Found via `codespell -q 3 -S
./options/locale,./options/license,./public/vendor,./web_src/fomantic -L
actived,allways,attachements,ba,befores,commiter,pullrequest,pullrequests,readby,splitted,te,unknwon`

Co-authored-by: techknowlogick <techknowlogick@gitea.io>
 2022-09-07 14:40:36 -04:00
ya
0bb2dabc1d Fix typo (#21004) 
Missing directory

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
 2022-08-31 12:47:34 -04:00
JonRB
1048fd8d13 Add instructions how to add service dependencies (#20968) 2022-08-28 23:28:42 +08:00
xinyu
0e7074c50c docs[zh-cn]: Install on Kubernetes (#20874) 
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
 2022-08-24 21:26:41 +08:00
xinyu
1b2dadff27 docs[zh-cn]: Managing Deployments With Environment Variables (#20817) 
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
 2022-08-17 15:44:07 -04:00
PEN²
557c07a479 Update zh-cn translation for Installation from source (#20772) 
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
 2022-08-14 12:03:12 -04:00
tryfail
2aed6e3594 Fix typos in backup documentation (#20567) 
Fixed multiple typos "/user/local/bin" to the proper path "/usr/local/bin"
 2022-08-01 13:16:38 +08:00
Ben Yanke
cd244d86fd Improve token and secret key generation docs (#20387) 
This PR proposes a minor improvement to the docs which allows a user to paste a single command into their terminal and get the needed tokens and keys.

Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
 2022-07-30 13:28:50 +08:00
Alex Papadimoulis
c8c9ce638e Added guidance on file to choose to download (#20474) 
* Added guidance on file to choose to download

* Update from-binary.en-us.md

* Update from-binary.en-us.md

* Update from-binary.en-us.md

* Update docs/content/doc/installation/from-binary.en-us.md

* Update docs/content/doc/installation/from-binary.en-us.md

Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: 6543 <6543@obermui.de>
 2022-07-29 14:07:52 +08:00
silverwind
fe1726a9e5 Add markdownlint (#20512) 
Add `markdownlint` linter and fix issues. Config is based on the one
from electron's repo with a few rules relaxed.
 2022-07-28 09:22:47 +08:00
Kevin Samuel
1ddb787537 patch (doc): add heading to ssh flow explanation (#20506) 2022-07-27 10:06:02 -04:00
Andrew Imeson
188b6561fd Correct code block in installation docs for Snap (#20440) 
Without this, it was rendering on the site like: "sh snap install gitea", instead of: "snap install gitea"

Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
 2022-07-22 18:12:27 +08:00
Jeremy
e67b09e06d Fix English mistakes in some Markdown documents (#20274) 2022-07-14 19:15:35 +08:00
wxiaoguang
095601b249 Update document to use FHS /usr/local/bin/gitea instead of /app/... for Docker (#19794) 
* Update document to use FHS `/usr/local/bin/gitea` instead of `/app/...` in Docker

* Update docs/content/doc/installation/with-docker.zh-cn.md
 2022-05-24 14:57:15 +08:00
ttys3
24d6db8bd1 Add health check endpoint (#18465) 
* chore: add health check endpoint

docs: update document about health check

fix: fix up Sqlite3 ping. current ping will success even if the db file is missing

fix: do not expose privacy information in output field

* refactor: remove HealthChecker struct

* Added `/api/healthz` to install routes.

This was needed for using /api/healthz endpoint in Docker healthchecks,
otherwise, Docker would never become healthy if using healthz endpoint
and users would not be able to complete the installation of Gitea.

* Update modules/cache/cache.go

* fine tune

* Remove unnecessary test code. Now there are 2 routes for installation (and maybe more in future)

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: Marcos de Oliveira <marcossantos@furb.br>
 2022-05-04 14:56:20 +03:00
wxiaoguang
02bccf285b Upgrade required git version to 2.0 (#19577) 
* Upgrade required git version to 2.0

* update document
 2022-05-02 20:30:24 +08:00
Lunny Xiao
c93373f03d Fix two typos (#19504) 2022-04-26 18:01:42 +02:00
Stephen J. Fuhry
3c2dad837d upgrade postgres refrence to 14 (#19416) 2022-04-16 11:59:56 -04:00
mscherer
41b1bf0566 Fix documentation and #19065 (#19067) 2022-03-13 18:30:58 +01:00
Nicolas Ferrari
0cec57d14a Update on-cloud-provider.md (#18807) 2022-02-18 23:26:00 +08:00
zeripath
f5a7d87492 Attempt to improve docs (yet again) (#18687) 
* Attempt to improve docs (yet again)

Attempt to make the passthrough docs clearer.
Add some more faq entries

Signed-off-by: Andrew Thornton <art27@cantab.net>

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Gusted <williamzijl7@hotmail.com>

* Update docs/content/doc/installation/with-docker.en-us.md

* Update docs/content/doc/installation/with-docker.en-us.md

Co-authored-by: Gusted <williamzijl7@hotmail.com>
 2022-02-10 19:20:06 +00:00
zeripath
de2778998d Make docker gitea/gitea:v1.16-dev etc refer to the latest build on that branch (#18551) 
* Make docker gitea/gitea:v1.16-dev etc refer to the latest build on that branch

One of the problems with our current docker tagging is that although we
have strict version tags, latest and dev we do not have a way for docker
users to track the current release branch. This PR simply suggests that
we use the 1.x-dev tag for these and we build and push these. This will
give users who want or need unreleased bug fixes the option of tracking
the pre-release version instead of simply jumping to dev.

Signed-off-by: Andrew Thornton <art27@cantab.net>
Co-authored-by: KN4CK3R <admin@oldschoolhack.me>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
 2022-02-03 09:47:27 +01:00
zeripath
f718e91627 Update the SSH passthrough documentation (#18366) 2022-01-23 12:25:25 -05:00
Andrey Esin
02f7ddd7a2 Fix identation typo in doc installation with Docker (#18233) 2022-01-11 19:33:42 +08:00
Greg Myers
59ef05d999 Fix typos in docs/content (#18215) 2022-01-09 19:53:03 +08:00
Tony
b11236fa29 docs: add various ways to install from package (#18120) 
zh-cn

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
 2021-12-30 12:28:56 +08:00
qwerty287
a0d1923637 Fix various typos of software names (#18083) 
* `git` -> `Git`
* `Github` and `github` -> `GitHub`
* `crowdin` -> `Crowdin`
* `git-lfs` -> `Git LFS`
* `githooks`, `git hooks`, `git-hooks` -> `Git Hooks`
* `discord` -> `Discord`
* `2fa` -> `2FA`
* `gitlab` and `Gitlab` -> `GitLab`
* `web hook` -> `webhook`
* `linux` -> `Linux`
* `sqlite` -> `SQLite`
* `MYSQL` and `mysql` -> `MySQL`
* rename refs to `master` branch -> `main`
* Fix English grammar
 2021-12-24 11:56:57 +08:00
qwerty287
56e65c86ff Fix various typos in docs (#17844) 2021-11-28 18:43:18 -05:00
qwerty287
a504ca2c61 Docs: replace gitea with Gitea (#17838) 
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
 2021-11-28 21:28:30 +08:00
缘生
f957d3b2af fix typo (#17614) 2021-11-14 17:32:48 -05:00
Renato Caldas
0fc10094b8 docs: add SSH passthrough instructions to with-docker-rootless (#17505) (#17508) 
The passthrough is based upon AuthorizedKeysCommand and a custom shell wrapper that forwards commands to the container over the docker pipe.
 2021-11-01 12:34:12 +00:00
Mashiro
46137111f0 docs: add permission notes to SSH Container Passthrough (#17347) 
* Update with-docker.en-us.md

* Update with-docker.en-us.md

Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
 2021-10-18 12:26:47 -04:00