public/gitea
1
0
Fork 0
mirror of https://github.com/go-gitea/gitea.git synced 2025-10-29 10:57:44 +09:00
Code Issues Packages Projects Releases Wiki Activity
15,539 Commits 19 Branches 240 Tags
d6cbf7f3156c55c89b69427b0247c8fd1fcab070
Commit Graph

37 Commits

Author SHA1 Message Date
Jason Song
f74bd9dc81 Docs for creating a user to run Gitea on Fedora/RHEL/CentOS (#24725) 
The current command doesn't work on Fedora/RHEL/CentOS.

- `--gecos`: use `--comment` instead.
- `--group`: use `--gid` instead, `--group` means "A list of
supplementary groups" on F/R/C.
- `--disabled-password`: leave `--password` empty instead, "The default
is to disable the password".
- `--home`: use `--home-dir` and `--create-home` instead.
 2023-05-15 23:03:38 +08:00
John Olheiser
bb25f85ce8 Refactor docs (#23752) 
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>
 2023-04-28 11:33:41 +08:00
Lunny Xiao
67103eb2bc Update docs markdown file weight to make it clear (#23909) 
For Docusaurus, it needs a meta data named `sidebar_position`, so we
copy all `weight` under `menu/sidebar` as top meta key.
 2023-04-04 21:47:31 +08:00
Lunny Xiao
e8433b7fe6 Restructure documentation. Now the documentation has installation, 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>
 2023-03-23 23:18:24 +08:00
zeripath
43405c35f0 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
b6d77229cf 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
John Olheiser
f82f1d05b1 Make app.ini read-only message more prominent (#21315) 2022-10-02 04:12:59 -04:00
Alex Papadimoulis
c5bdea9bbc 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
ae52df6a64 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
Jeremy
725f9e40b3 Fix English mistakes in some Markdown documents (#20274) 2022-07-14 19:15:35 +08:00
wxiaoguang
509d811243 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
qwerty287
5754080eb9 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
b1df890951 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
Norwin
fc1d9629c6 Clarify GPG binary check (#14832) 
fixes #14817

Co-authored-by: techknowlogick <techknowlogick@gitea.io>
 2021-07-01 16:14:09 +02:00
Lasse Brandt Thomsen
0fe32826ed Allow read/write to user root and only read to group git on documentation (#15041) 
Co-authored-by: Lasse Brandt Thomsen <lasse@bitmand.dk>
 2021-03-20 00:45:04 +01:00
Patrick Schratz
af79677a44 Reformat docs (#13897) 
Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: Lauris BH <lauris@nix.lv>
 2020-12-09 07:47:06 +01:00
6543
6bdcacd73b Added Table of Contents to long documentation pages (#13890) 
* Redo #13836 with new shortcode
(https://gitea.com/gitea/theme/pulls/90)

* add Api Usage

Co-authored-by: techknowlogick <techknowlogick@gitea.io>
 2020-12-07 23:52:26 -05:00
John Olheiser
1d6b565de4 Refactor docs (#13275) 
* First pass

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* More changes

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Redirects

Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2020-10-23 11:59:45 -04:00
Km
d0e7361bd9 Propose an explanation how to restart gracefully gitea after an update (#10866) 
Co-authored-by: guillep2k <18600385+guillep2k@users.noreply.github.com>
Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: Lauris BH <lauris@nix.lv>
 2020-04-30 15:14:27 +03:00
zeripath
1853131d42 Use keys.openpgp.org instead of pgp.mit.edu (#11249) 
The SKS Keyserver network has been under attack with poisoned
certificates since at least 2019. Downloading a poisoned certificate has
the awful side-effect of completely breaking your keyring and most
software has now moved off the network and uses the keys.openpgp.org
which has a different protocol instead - in fact one whereby emails are
verified.

For more details regarding the attack see: https://gist.github.com/rjhansen/67ab921ffb4084c865b3618d6955275f

See: https://keys.openpgp.org/about and https://keys.openpgp.org/about/faq

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

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
 2020-04-30 12:08:43 +03:00
John Olheiser
3f0cb8b33a Remove test from installation directions (#10873) 
Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2020-03-29 11:07:40 +01:00
8ctopus
8a828500e6 Doc config file should not be readable by others as it contains sensitive info (#8385) 2019-10-05 17:16:30 +03:00
John Olheiser
4ea9a377db Add config option and shortcode for Gitea version (#7940) 
Signed-off-by: jolheiser <john.olheiser@gmail.com>
 2019-08-23 09:55:06 +08:00
Alexandru Bucur
36448bc923 1.8.3 release (#7332) 2019-06-30 17:17:43 -04:00
suisseWalter
181b7c99ed Added Note about arm7 version to doc (#6983) 
Appended the Troubleshooting section with a subsection about the problems with the arm7 version and the recommendation to switch to arm6.
 2019-05-23 18:12:59 +01:00
nodiscc
0f54f42646 docs: document setup with read-only config (#6348) 2019-04-04 10:21:54 -04:00
Aidan Fitzgerald
f5cf9a8355 Copyedit docs (#6275) 2019-03-09 16:15:45 -05:00
John Olheiser
4b7237b63e Doc updates for customization and installation. (#6176) 
* Doc updates and changing default sqlite DB path

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Update customizing locales and THEMES

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Add link to templates directory

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Add portion for final step of running Gitea

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Add recommended to service file usage

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Removed DB path change, moving to another PR
Updated doc sentence structure

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Revert change to template wording

Signed-off-by: jolheiser <john.olheiser@gmail.com>

* Move recommended run-type to top
 2019-02-28 20:09:47 +08:00
vee w
573650877c Fix wrong URL to download link. (#5881) 
* Fix wrong URL to download link.

The link does not contain trailing slash and cause error page displayed.

* Update version
 2019-01-28 10:53:16 -05:00
Antoine GIRARD
e4b8103ac7 Use fingerprint in place of id (#5099) 2018-10-18 00:15:02 -04:00
SagePtr
3ad5399a31 Update gitea version in install-from-binary docs (#4670) 2018-08-11 15:47:14 -04:00
Benedikt Kroll
d57233680b Add documentation on how to update Gitea to new version (#4500) 2018-07-30 11:35:05 -04:00
techknowlogick
61b40520ba GPG verification docs (#4381) 
* GPG verification docs

* update URL
 2018-07-06 09:36:54 +08:00
Lauris BH
1aee261aae More detailed documentation on how to set up from binary (#4121) 
* More detailed documentation on how to set up from binary
Also change recommended file locations
 2018-06-04 22:02:04 -04:00
Michael Lustfield
3ee8be3849 General documentation cleanup (#3317) 
* Clean up spelling, grammar, perspective, whitespace, language, markup, etc.
 2018-01-08 23:48:42 +01:00
Kim "BKC" Carlbäcker
923c0105f4 Update gitea version on docs/install-from-binary (#3333) 
* Update gitea version on docs/install-from-binary

* Update all versions
 2018-01-09 00:48:05 +02:00
techknowlogick
fb5c6b6444 Import docs into main repository (#2874) 
* import docs into main repository

Signed-off-by: Matti Ranta <matti@mdranta.net>
 2017-11-26 23:44:32 +02:00