summaryrefslogtreecommitdiffstats
path: root/docs/content/doc/help
Commit message (Collapse)AuthorAgeFilesLines
* Docusaurus-ify (#26051)John Olheiser2023-07-268-1051/+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>
* Update path related documents (#25417)wxiaoguang2023-07-191-5/+3
| | | | | | | | | | | | Update WorkPath/WORK_PATH related documents, remove out-dated information. Remove "StaticRootPath" on the admin config display page, because few end user really need it, it only causes misconfiguration. ![image](https://github.com/go-gitea/gitea/assets/2114189/8095afa4-da76-436b-9e89-2a92c229c01d) Co-authored-by: Giteabot <teabot@gitea.io>
* Move public asset files to the proper directory (#25907)wxiaoguang2023-07-181-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Move `public/*` to `public/assets/*` Some old PRs (like #15219) introduced inconsistent directory system. For example: why the local directory "public" is accessed by `http://site/assets`? How to serve the ".well-known" files properly in the public directory? For convention rules, the "public" directory is widely used for the website's root directory. It shouldn't be an exception for Gitea. So, this PR makes the things consistent: * `http://site/assets/foo` means `{CustomPath}/public/assets/foo`. * `{CustomPath}/public/.well-known` and `{CustomPath}/public/robots.txt` can be used in the future. This PR is also a prerequisite for a clear solution for: * #21942 * #25892 * discourse.gitea.io: [.well-known path serving custom files behind proxy?](https://discourse.gitea.io/t/well-known-path-serving-custom-files-behind-proxy/5445/1) This PR is breaking for users who have custom "public" files (CSS/JS). After getting approvals, I will update the documents. ---- ## ⚠️ BREAKING ⚠️ If you have files in your "custom/public/" folder, please move them to "custom/public/assets/". --------- Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Giteabot <teabot@gitea.io>
* Remove "CHARSET" config option for MySQL, always use "utf8mb4" (#25413)wxiaoguang2023-06-211-2/+0
| | | | | | | | | | | | | In modern days, there is no reason to make users set "charset" anymore. Close #25378 ## :warning: BREAKING The key `[database].CHARSET` was removed completely as every newer (>10years) MySQL database supports `utf8mb4` already. There is a (deliberately) undocumented new fallback option if anyone still needs to use it, but we don't recommend using it as it simply causes problems.
* Use the new download domain replace the old (#25405)Lunny Xiao2023-06-211-1/+1
| | | As title.
* Add link to support page for commercial support (#25293)techknowlogick2023-06-161-0/+1
|
* Improve some documents: release version, logging, NFS lock (#25202)wxiaoguang2023-06-122-42/+23
| | | | | | | | | | | Close #23654 Close #24684 @techknowlogick I still think we need to rename https://dl.gitea.com/gitea/1.20/ to https://dl.gitea.com/gitea/1.20-nightly/ `/gitea/1.20/` is quite confusing, it needs these words to explain why. If we call it `1.20-nightly`, the FAQ can be simplified a lot.
* Fix documentation ref (#24934)Lunny Xiao2023-05-261-19/+19
| | | Fix documentation ref
* Add Chinese docs for help, contribution and development (#24925)HesterG2023-05-251-0/+472
|
* Fix document and improve comment (#24844)wxiaoguang2023-05-221-1/+1
| | | | | | | | | | * Fix broken doc link: https://github.com/go-gitea/gitea/actions/runs/5041309438/jobs/9040887385 * Improve comments about how font weight works: https://github.com/go-gitea/gitea/pull/24827#pullrequestreview-1435584800 --------- Co-authored-by: silverwind <me@silverwind.io>
* Refactor docs (#23752)John Olheiser2023-04-2814-134/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* Update documentation to explain which projects allow Gitea to host static ↵65432023-04-111-0/+8
| | | | | | | | | | | | 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>
* Update docs markdown file weight to make it clear (#23909)Lunny Xiao2023-04-0410-17/+17
| | | | For Docusaurus, it needs a meta data named `sidebar_position`, so we copy all `weight` under `menu/sidebar` as top meta key.
* Restructure documentation. Now the documentation has installation, ↵Lunny Xiao2023-03-231-15/+15
| | | | | | | | | | | | | | | | | | | | | | 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 repo adoption to FAQ (#22778)John Olheiser2023-02-061-0/+11
| | | | This should be a simple set of steps to achieve repo adoption.
* docs: add swagger.json file location to FAQ (#22489)John Olheiser2023-01-171-0/+2
| | | | | | This just adds a mention on how to get the `swagger.json` for an instance. Signed-off-by: jolheiser <john.olheiser@gmail.com>
* Attempt clarify AppWorkPath etc. (#21656)zeripath2022-11-091-13/+17
| | | | | | | | | | 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>
* Fix the hook related FAQ contents (#21297)wxiaoguang2022-09-291-5/+5
| | | | | | | | | Follows https://github.com/go-gitea/gitea/issues/21129#issuecomment-1260802986 * https://github.com/go-gitea/gitea/issues/21129#issuecomment-1260802986 A lot of users are asking similar questions. The old content in FAQ doesn't seem to be related to the problem.
* Clarify that `ENABLE_SWAGGER` only influences the API docs, not the routes ↵delvh2022-09-201-5/+5
| | | | | | | (#21215) Previously, the docs seemed to suggest that you can disable the API completely by setting `ENABLE_SWAGGER=false`. This is not the case.
* Upgrade the document about how to collect logs for systemd and docker (#21101)wxiaoguang2022-09-072-4/+8
| | | | Many users (#21099) do not know how to collect logs if they are using systemd. This PR makes the document more clear.
* docs: move search input to navbar (#20551)Norwin2022-08-087-24/+54
| | | | | | * remove search item from sidebar * fix search for some docs languages Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
* Add markdownlint (#20512)silverwind2022-07-283-48/+84
| | | | Add `markdownlint` linter and fix issues. Config is based on the one from electron's repo with a few rules relaxed.
* Improve pprof doc (#20463)wxiaoguang2022-07-241-3/+4
|
* Add Cloudflare auto-minify to FAQ (#20430)John Olheiser2022-07-211-0/+6
|
* Improve log document (#20097)wxiaoguang2022-06-241-4/+20
| | | | | | | | | | | | | | | | | | | * Improve log document * Update docs/content/doc/help/seek-help.en-us.md Co-authored-by: delvh <dev.lh@web.de> * Update docs/content/doc/help/seek-help.en-us.md Co-authored-by: Gusted <williamzijl7@hotmail.com> * Use different log names to avoid conflicts * Update seek-help.en-us.md Co-authored-by: delvh <dev.lh@web.de> Co-authored-by: Gusted <williamzijl7@hotmail.com> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
* docs: update the ROOT documentation and error messages (#19832)singuliere2022-05-311-2/+3
| | | | | | | | | | | | | | | * docs: update the ROOT documentation and error messages * The documentation now reflects what happens in the setting/repository.go::newRepository function: filepath.Join(AppWorkPath, RepoRootPath) was missing. * The error message displayed when RepoRootPath is not found now displays the value of RepoRootPath. Given the complexity of the construction of this value, only referring to it in the abstract is likely to be misleading to the Gitea admin trying to interpret the message. Co-authored-by: delvh <dev.lh@web.de>
* docs: FAQ: the WorkPath can be set from --work-path (#19822)singuliere2022-05-281-1/+2
|
* Attempt to improve docs (yet again) (#18687)zeripath2022-02-101-0/+48
| | | | | | | | | | | | | | | | | | | | * 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>
* Fix various typos of software names (#18083)qwerty2872021-12-241-3/+3
| | | | | | | | | | | | | | | | * `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
* Improve seek-help documents (#17895)wxiaoguang2021-12-033-10/+20
| | | | * Add pprof information to seek-help documents * Improve zh-cn and zh-tw documents
* Fix various typos in docs (#17844)qwerty2872021-11-281-1/+1
|
* Use light/dark theme based on system preference (#17051)Gwyneth Morgan2021-09-271-1/+1
| | | | | | | | Add a new default theme `auto`, which will automatically switch between `gitea` (light) and `arc-green` (dark) themes depending on the user's operating system settings. Closes: #8183
* Added documentation about 413 errors with an nginx solution (#15313)Avahe Kellenberger2021-07-101-0/+6
| | | | | | | * Added documentation about 413 errors with an nginx solution. Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: Norwin <noerw@users.noreply.github.com> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Fix various documentation, user-facing, and source comment typos (#16367)luzpaz2021-07-081-1/+1
| | | | | * Fix various doc, user-facing, and source comment typos Found via `codespell -q 3 -S ./options/locale,./vendor -L ba,pullrequest,pullrequests,readby`
* MySQL 5 FAQ (#15729)John Olheiser2021-05-051-1/+7
| | | | | | | * MySQL 5 Signed-off-by: jolheiser <john.olheiser@gmail.com> * Wording
* Change the chinese discuss link to discourse (#15533)Lunny Xiao2021-04-182-2/+2
|
* Allow blocking some email domains from registering an account (#14667)Damien Goutte-Gattat2021-02-151-5/+6
| | | | | | | | | Gitea allows to whitelist email domains so that only email addresses from certain domains are allowed to register an account, but does not currently allows to do the opposite: blacklisting email domains so that addresses from certain domains are *forbidden* to register an account. The idea has been briefly mentioned in the discussion about issue #6350, but never implemented. This PR does that. The rationale is that, in my experience of running a Gitea instance, *a single email domain* is responsible for *most* of the spam accounts, and for *all* of the spam accounts that manage to get past the email confirmation step. So on top of the other spam mitigation measures already available (email confirmation, CAPTCHA, etc.), having the option to block a particularly annoying domain would be helpful. close #13628
* [docs] Add zh-tw Translations (#14507)kevinlin182021-01-292-2/+33
|
* Store repository data in data path if not previously set (#13991)techknowlogick2020-12-151-1/+1
| | | | | | | | | | | | | * Store repository data in data path if not previously set * update docs * Update docs/content/doc/advanced/config-cheat-sheet.en-us.md Co-authored-by: silverwind <me@silverwind.io> * update docs Co-authored-by: silverwind <me@silverwind.io>
* Reformat docs (#13897)Patrick Schratz2020-12-097-71/+101
| | | | Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Lauris BH <lauris@nix.lv>
* Added Table of Contents to long documentation pages (#13890)65432020-12-071-31/+1
| | | | | | | | * Redo #13836 with new shortcode (https://gitea.com/gitea/theme/pulls/90) * add Api Usage Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Remove Noto Color Emoji fallback (#13838)silverwind2020-12-041-0/+4
| | | | | It's causing browser errors logged in Firefox under certain circumstances, and I think we're better off recommending Linux users to install a proper emoji font into their system.
* fixed and updated FAQ table of contents links (#13835)Holger Schmidt2020-12-041-33/+33
| | | | | | * fixed and updated FAQ table of contents links, rewording one heading that wouldn't generate a working link Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Lauris BH <lauris@nix.lv>
* Format files (#13698)65432020-11-285-15/+11
| | | | | | | | | | | | | | | | * align "make help" * format * untouch build/generate-svg.js * untouch .eslintrc * combine editorconfig's * rm editorconfig Co-authored-by: Lauris BH <lauris@nix.lv> Co-authored-by: techknowlogick <techknowlogick@gitea.io>
* Refactor docs (#13275)John Olheiser2020-10-231-2/+2
| | | | | | | | | | | | | * 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>
* Fix hugo shortcode typo in faq (#12987)raoulb2020-09-301-1/+1
| | | | | * Fix hugo shortcode typo in faq * Switch to using language tags
* Add MySQL FAQ section (#12780)zeripath2020-09-091-1/+29
| | | | | | | | | | | | | * Add MySQL FAQ section Signed-off-by: Andrew Thornton <art27@cantab.net> * Update docs/content/doc/help/faq.en-us.md * Update docs/content/doc/help/faq.en-us.md Co-authored-by: mrsdizzie <info@mrsdizzie.com> Co-authored-by: mrsdizzie <info@mrsdizzie.com>
* Add FAQ for markdown (#10611)John Olheiser2020-03-051-0/+6
| | | | | | | | * Add FAQ for markdown * Expand explanation @guillep2k Signed-off-by: jolheiser <john.olheiser@gmail.com>
* update discord link (#10455)65432020-02-251-1/+1
|
* Update migration instructions (#9955)John Olheiser2020-01-241-1/+3
| | | | Signed-off-by: jolheiser <john.olheiser@gmail.com>
generated by cgit v1.2.3 (git 2.39.1) at 2025-04-03 17:09:19 +0000