0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-12-25 22:40:42 -05:00
Commit graph

357 commits

Author SHA1 Message Date
Earl Warren
a09cea8876 developer: compiling requires go v1.22 not v1.21 2024-05-16 21:05:37 +00:00
0ko
a83db24507 Replace Knut source link with IA 2024-05-16 19:30:20 +05:00
adbagio
f5b51da942 adds and updates hierarchy section 2024-05-16 07:40:42 +00:00
Earl Warren
2821d3cec4
admin: command-line: add actions-artifacts option
scripts/cli-docs.sh run next > docs/admin/command-line.md

Refs: https://codeberg.org/forgejo/forgejo/pulls/3772
2024-05-15 20:08:51 +02:00
TheFox0x7
b6b99c0b55 Add Caddy config to reverse proxy section (#605)
Added Caddy example configs, turned on syntax highlighting in nginx/apache

Closes: forgejo/website#232
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/605
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: TheFox0x7 <thefox0x7@gmail.com>
Co-committed-by: TheFox0x7 <thefox0x7@gmail.com>
2024-05-14 23:07:03 +00:00
0ko
fb73fd507d Localization: add instructions for fixing various failures with Weblate CL 2024-05-14 22:32:31 +00:00
Crown0815
720667cf04 Fix incorrect default value in CheatSheet for attachment MaxSize
I tested my forgejo instance and it says that it cannot upload files larger than 2048 MB.
I also confirmed on the gitea cheatsheet where the value is also 2048 MB
(see https://docs.gitea.com/administration/config-cheat-sheet#issue-and-pull-request-attachments-attachment)
2024-05-14 10:00:38 +00:00
jwildeboer
784e395e97 Update Issue/PR Template doc (#609)
Preview: https://forgejo.codeberg.page/@docs_pull_609/docs/next/user/issue-pull-request-templates/#directory-names

Proposal based on https://codeberg.org/forgejo/docs/issues/607 to make the docs more readable and add the `.forgejo` directory. Also added the `ref` and `labels` options to the yaml example.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/609
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: jwildeboer <jwildeboer@noreply.codeberg.org>
Co-committed-by: jwildeboer <jwildeboer@noreply.codeberg.org>
2024-05-12 18:43:11 +00:00
Kwonunn
c1b7969c1d Reverse Proxy setup guide (#600)
I've added a more comprehensive guide to set up Reverse Proxies.

So far I've added nginx configuration, I'm also planning to add apache configuration later on.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/600
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Kwonunn <kwonunnx@gmail.com>
Co-committed-by: Kwonunn <kwonunnx@gmail.com>
2024-05-10 07:22:19 +00:00
Earl Warren
359caf8476 admin(actions): the latest stable runner is 3.4.1 2024-05-10 07:19:38 +00:00
cascading-pr
131300c912 cascading-pr update 2024-05-10 05:39:23 +00:00
Earl Warren
38c90ce5d6 developer(infrastructure): ubuntu-runner.forgejo.org 2024-05-07 10:54:55 +00:00
Earl Warren
5acda1e0b2 developer: release: cut the documentation branch
- add a checklist to the release instructions
- use a pattern for push instead of an explicit list of branches
  it was previously advisable to avoid conflicts when there was
  no automated backports but it is no longer necessary
2024-05-07 10:53:58 +00:00
Yaroslav Halchenko
9ad5f2ab0f Add codespell support (without CI) and make it fix some typos (#536)
Per "request" of @0ko in https://codeberg.org/forgejo/forgejo/pulls/3270#issuecomment-1774032

TODOs
- postponed: how to add codespell (written in Python) to CI -- separate workflow? add to some other step? to some other tool/specification?

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/536
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Yaroslav Halchenko <debian@onerussian.com>
Co-committed-by: Yaroslav Halchenko <debian@onerussian.com>
2024-05-05 14:53:04 +00:00
0ko
4cba3d36b3 Fix dead links 2024-05-05 06:18:43 +00:00
OniriCorpe
cd06bf37c5 Fix the 'Forgejo numbering scheme' link 2024-05-02 23:52:48 +00:00
alydev
0bfc31bd0a
SSL note for minio storage, fixed dead link 2024-05-01 18:33:10 +10:00
Earl Warren
2a12684354
admin(cli): update 2024-04-30 17:37:19 +02:00
Earl Warren
d9c4a8bd18 admin: upgrade: drop issue.created when upgrading from gogs
Refs: https://codeberg.org/forgejo/forgejo/issues/3488
2024-04-28 20:37:17 +00:00
Earl Warren
bea94cd9bd Revert "Add rootless installation instructions"
This reverts commit 345765e21f.
2024-04-28 20:36:03 +00:00
Firepup650
a1106f2fce Fix a broken link
`[clean up job]../../admin/config-cheat-sheet/#cron---cleanup-expired-packages-croncleanup_packages)` -> `[clean up job](../../admin/config-cheat-sheet/#cron---cleanup-expired-packages-croncleanup_packages)`
2024-04-28 14:55:54 +00:00
Robin Kloppe
d9db0d13f6 Added Repo Mirros (#568)
In a next step https://codeberg.org/forgejo/forgejo/pulls/3503 can be merged

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/568
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Robin Kloppe <git@mainboarder.de>
Co-committed-by: Robin Kloppe <git@mainboarder.de>
2024-04-28 08:58:32 +00:00
Otto Richter
c6c39005b0 Document database.MAX_OPEN_CONNS limit
See https://codeberg.org/forgejo/forgejo/pulls/3500
and https://codeberg.org/forgejo/forgejo/pulls/3383
for details.
2024-04-27 22:39:00 +02:00
cascading-pr
ef11b41eb5 cascading-pr update 2024-04-25 13:40:26 +00:00
0ko
bcd7348a70 localization admin: add Weblate announcement 2024-04-24 18:58:31 +05:00
Earl Warren
a0477a8300 LTS: is not part of the metadata & CLI updates (#561)
- LTS are listed in the table, no hint in the version number
- update the RC release names
- CLI updates

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/561
Co-authored-by: Earl Warren <contact@earl-warren.org>
Co-committed-by: Earl Warren <contact@earl-warren.org>
2024-04-23 15:57:31 +00:00
Earl Warren
cd3c76c05d docs: user: new section on comment on issues & PR via email 2024-04-23 09:03:49 +00:00
Earl Warren
6aa9b491a0 sync with Gitea e865de1e9d65dc09797d165a51c8e705d2a86030
cd docs
git diff d3982bcd814bac93e3cbce1c7eb749b17e413fbd..e865de1e9d65dc09797d165a51c8e705d2a86030 -- $(find . -type f -name '*en-us*')
2024-04-23 07:16:10 +00:00
Earl Warren
06233a63cd developer: release: octopuce is not publicly visible 2024-04-21 07:03:44 +00:00
Earl Warren
51a1f2951e developer: infrastructure: v7.next.forgejo.org 2024-04-21 06:52:09 +00:00
0ko
82ab0bb31b developer: update localization admin guides 2024-04-21 06:49:58 +00:00
crystal
2a91eef705 prerelease version docs 2024-04-21 06:47:51 +00:00
Otto Richter
7c8c649cc9 Sync list of default themes
See https://codeberg.org/forgejo/forgejo/pulls/1746
2024-04-21 06:47:08 +00:00
crystal
d58d729c58
fix 404 2024-04-20 16:59:47 -06:00
Earl Warren
4ce64e2840 docs: pick the Forgejo release from experimental (#542)
in the case of a release that is not yet published, it will exist as
release candidates in the experimental organization. Every release go
through there and it is a reliable source.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/542
Reviewed-by: crystal <crystal@noreply.codeberg.org>
Co-authored-by: Earl Warren <contact@earl-warren.org>
Co-committed-by: Earl Warren <contact@earl-warren.org>
2024-04-20 08:39:14 +00:00
crystal
bd8e4e588a timetzdata is in the release build tags 2024-04-20 07:26:55 +00:00
Earl Warren
396b73db5d developer: 7.0 pushed to 23 April 2024
Refs: https://matrix.to/#/!zpNKWqkiEOyljSMQDK:matrix.org/$NbJVQF3bOEMbfFbfq-IhydQPukQuHvsz3Vi6A2ozWCU?via=schinas.net&via=matrix.org&via=envs.net
2024-04-19 15:06:40 +00:00
crystal
34ab587e0f
replace gna.org links with archive.org mirrors
gna.org is apparently gone
2024-04-18 21:38:30 -06:00
Earl Warren
d1662f520e developer: infrastructure: blacklist bots that do not obey robots.txt
They get /forgejo/forgejo/archive/100448a007707c049a769cb71cd170fcb5b64a25.bundle

despite https://code.forgejo.org/robots.txt having

Disallow: /*/*/archive/
Disallow: /*/*/archive/*.bundle
2024-04-15 10:38:55 +00:00
Christian Drexler
798fee5b11 small update to docker compose (quoted boolean, compose as module) (again) (#525)
Hi,
somehow I made a hash of the last PR #522 so it failed linting again. I hope it is ok now. Sorry for the noise!

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/525
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Christian Drexler <xunzi@noreply.codeberg.org>
Co-committed-by: Christian Drexler <xunzi@noreply.codeberg.org>
2024-04-14 12:31:01 +00:00
0ko
b4354d111a Developer: Base localization: add Contributing section 2024-04-11 14:43:22 +00:00
oliverpool
cc1a240739 webhooks: add SourceHut Builds and matrix, organize by type 2024-04-10 17:36:35 +02:00
natct
c134c1bb09 Badges are enabled by default. 2024-04-10 11:28:01 +02:00
natct
e0200e8b3c Add Repository Activity. 2024-04-10 10:06:04 +02:00
jilen
81154d6fa5
add minio bucket lookup 2024-04-10 07:09:11 +02:00
Ada
53da12e153
Improve wording 2024-04-05 22:11:28 +02:00
Ada
a2824865fa
add documentation for cron.delete_inactive_accounts 2024-04-05 21:26:12 +02:00
Mai-Lapyst
b47946be04 Document the new preview of permalinks 2024-04-05 04:21:34 +00:00
Earl Warren
e686086717 developer: dependency management guide 2024-04-03 09:53:18 +00:00
Gergely Nagy
6398dc14de
Revert "admin: Document [repository].DOWNLOAD_OR_CLONE_METHODS"
This reverts commit 28cdb8ca82, because
the functionality has been superseded by a different implementation.

Signed-off-by: Gergely Nagy <forgejo@gergo.csillger.hu>
2024-04-01 22:13:00 +02:00
0ko
23cee48c5b config: socks are socks5
Ref https://codeberg.org/forgejo/forgejo/issues/2943
2024-04-01 19:00:10 +05:00
Shiny Nematoda
e6d29aec71 user: update code search 2024-03-31 08:02:55 +00:00
Earl Warren
0c64312770
developer: release: update from cutting the v7.0 branch
Refs: https://codeberg.org/forgejo/forgejo/issues/2425
2024-03-30 15:36:18 +01:00
Earl Warren
76562da938 LTS EOL must overlap the next LTS 2024-03-30 08:19:44 +00:00
Earl Warren
73e569c299 user: release: LTS support 2024-03-30 08:19:44 +00:00
Pi-Cla
3693fe0926 Mention code.forgejo.org mirror
The docker installation page does not link to the download
page so we should also mention the mirror here
2024-03-27 16:28:10 -06:00
Earl Warren
8f79cbc4ce docs: developer: forgejo-backport-action
Refs: https://codeberg.org/forgejo/forgejo/issues/2725
2024-03-25 23:03:59 +00:00
Earl Warren
9c64779735
docs: developer: forgejo-renovate-action
Refs: https://codeberg.org/forgejo/forgejo/issues/2765
2024-03-24 14:23:39 +01:00
0ko
8dd6e0fbcf I18N: update language dict 2024-03-23 19:28:12 +05:00
Bao Trinh
ff3d0ddea6
admin: logging-documentation: fix inaccuracies 2024-03-21 07:47:39 -05:00
cascading-pr
a9205a81e9 cascading-pr update 2024-03-20 14:51:43 +00:00
Earl Warren
b5c7a08a99
developer: localization: workflow for PR that modify translations 2024-03-20 08:34:19 +01:00
Panagiotis "Ivory" Vasilopoulos
02aa6e323b Capitalize titles of guide index pages 2024-03-17 20:50:02 +01:00
Mai-Lapyst
89d977a913 Fixes a typo for steps in workflows
...where the 'steps' key of jobs is documented as 'step'
2024-03-16 02:45:22 +00:00
rom4nik
206ed546b9 developer/infrastructure.md: ephemral -> ephemeral 2024-03-16 02:44:22 +00:00
Mai-Lapyst
d6dca55482
Document jobs.<job_id>.steps[*].env 2024-03-15 08:50:21 +01:00
0ko
fe8a889cf4 developer: add Base localization guide 2024-03-11 18:00:00 +05:00
Rik Huijzer
05f8dd4b77 admin: clarify the Runner label keyword (#475)
It was quite painful yesterday to try to figure out why my workflow didn't work anymore after the Forgejo migration. Turns out that `gitea/act_runner` used a different default Docker image. With this PR, it should be clearer to other people what is the meaning of the labels.

Co-authored-by: Rik Huijzer <github@huijzer.xyz>
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/475
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Rik Huijzer <rikh@noreply.codeberg.org>
Co-committed-by: Rik Huijzer <rikh@noreply.codeberg.org>
2024-03-10 06:29:20 +00:00
Rik Huijzer
4ff026d3ed admin: add a Docker Compose runner example (#474)
This PR extends the examples that were provided by @earl-warren in https://codeberg.org/forgejo/runner. I've tested this configuration twice today on two completely separate servers. For more information about the whole process that I've used, see https://huijzer.xyz/posts/forgejo-setup/.

I'll try to extract upstream a bit more information to the Forgejo docs. Feel free to take anything from my blog that seems useful and don't worry about credits. Feel free to copy whatever seems useful.

Co-authored-by: Rik Huijzer <github@huijzer.xyz>
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/474
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Rik Huijzer <rikh@noreply.codeberg.org>
Co-committed-by: Rik Huijzer <rikh@noreply.codeberg.org>
2024-03-09 03:50:55 +00:00
Rik Huijzer
7a66846f4a Incorporate feedback
Co-authored-by: Earl Warren <contact@earl-warren.org>
2024-03-08 07:24:05 +01:00
Rik Huijzer
1288f10550 Fix lint issue 2024-03-07 18:21:29 +01:00
Rik Huijzer
345765e21f Add rootless installation instructions 2024-03-07 17:04:47 +01:00
Gusted
3886dc485b admin: move Gitea migration to its own page
It doesn't feel right to have such guide on the installation page, it
feels more natural to have it's own page. This also keeps the
'installation' page clean, which currently feels more like an index
page, given it's linking to two other pages (installation from {binary,docker}).
2024-03-07 11:13:53 +00:00
Earl Warren
33d2622dff
developer: set the tag of the built image
Otherwise it won't show in `docker image ls` which can be confusing.
2024-03-06 14:31:31 +08:00
0ko
3f9b7ac809 localization: more information for team applicants 2024-03-05 13:41:44 +05:00
Earl Warren
920b0e97fd
update admin & user guide with semantic versioning
* Explain how the semantic version relate to the API
* Update the admin guide terminology
* Add a legacy section in the user reference guide
2024-03-02 20:41:58 +08:00
inference
8e7aa6b332 Semantic Versioning Updates (#460)
Preview: https://forgejo.codeberg.page/@docs_pull_460/docs/next/user/semver/

---

This pull request updates the Semantic Versioning mentions in the Forgejo documentation, as discussed in [forgejo/forgejo #2459](https://codeberg.org/forgejo/forgejo/pulls/2459).

It is currently a draft and feedback on how to approach this is appreciated. I think the Forgejo v1.19 section should be renamed to "legacy" or at least mention it due to it being the legacy versioning scheme, and moved below the new SemVer-compliant scheme. You can see how I've done that myself on [my website](https://inferencium.net/about.xhtml#versioning-numbering_scheme) for a taste of how it would look to a user.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/460
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: inference <admin@inferencium.net>
Co-committed-by: inference <admin@inferencium.net>
2024-03-02 10:54:49 +00:00
Earl Warren
937e55acc0 developer: releases: replace X.Y.Z+A.B.C with X.Y.Z+gitea-A.B.C
Followup of https://codeberg.org/forgejo/forgejo/pulls/2514
2024-03-02 10:31:08 +00:00
cascading-pr
87e204a528 cascading-pr update 2024-03-01 01:03:14 +00:00
Shiny Nematoda
6cc672040b admin: Document fallback behavior of repo indexer (#444)
ref: https://codeberg.org/forgejo/forgejo/pulls/1594

Preview: https://forgejo.codeberg.page/@docs_pull_444/docs/next/user/code-search/
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/444
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Shiny Nematoda <snematoda@noreply.codeberg.org>
Co-committed-by: Shiny Nematoda <snematoda@noreply.codeberg.org>
2024-02-29 15:06:38 +00:00
Earl Warren
42d27fe502
developer: localization: warn before locking 2024-02-28 11:35:14 +01:00
Earl Warren
0127a9b0a4
developer: infrastructure: check for next.forgejo.org upgrades hourly 2024-02-27 12:41:31 +01:00
Andre601
da8202b897 User: Update info on configuring auth for maven package 2024-02-26 15:24:18 +00:00
Earl Warren
7dee6e6060 developer: infrastructure: no need for Enough, use ssh instead
It lowers the learning curve a little more for future sysadmins.

Also remove the obsolete hardware paragraph in the code.forgejo.org
page.
2024-02-26 14:18:39 +00:00
Earl Warren
09dfcc4ec0 sync with Codeberg 85d333f48badb27f8e4371263db3354f70836dfd
https://codeberg.org/Codeberg/Documentation

git diff 7bb8fa5ca559073c028805888195ee31b1f3d9c2..85d333f48badb27f8e4371263db3354f70836dfd > doc.patch
2024-02-25 18:03:50 +00:00
Earl Warren
24def40ad3 sync with Gitea d3982bcd814bac93e3cbce1c7eb749b17e413fbd
git diff abe8fe352711601fbcd24bf4505f7e0b81a93c5d..d3982bcd814bac93e3cbce1c7eb749b17e413fbd -- $(find . -type f -name '*en-us*')
2024-02-25 18:03:28 +00:00
Earl Warren
f9702d46cd
developer: infrastructure: next.forgejo.org auto-upgrades 2024-02-24 23:11:36 +01:00
Earl Warren
62c3b2540b
developer: release: the version metadata is not in the tag
It is added to the version when building it but is not part of the
release name.

Refs: https://codeberg.org/forgejo/forgejo/pulls/2459
2024-02-24 14:11:02 +01:00
Gusted
aa48cb3b99 admin: Add ambiguous character detection config
- Ref: https://codeberg.org/forgejo/forgejo/pulls/2427
2024-02-24 12:25:53 +00:00
Marko Korhonen
8bc412af4c
Fix typo 2024-02-24 11:19:09 +02:00
Earl Warren
6bb6309a4e
developer: release process update for the hard fork
* Release number is v7.0.0+1.22.0 and following semantic versioning
* Remove the workflow page which is no longer needed as:
  * it is implicitly understood pull requests go to the default branch
  * testing requirements are documented in the testing.md page
* Explain how to cut a release and set the tag in forgejo-integration
  for proper numbering of the test releases that come out of the
  development branch

Refs: https://codeberg.org/forgejo/forgejo/pulls/2448
2024-02-23 16:53:01 +01:00
Earl Warren
299a3a2951
developer: testing: split this section out of compilation 2024-02-21 23:41:46 +01:00
Earl Warren
a50d5e1f00
developer: localization: admin duties
after a few rounds of merging translations the checklist is slightly
different
2024-02-21 14:39:50 +01:00
Gusted
162f0ad25c
admin: add new option to config cheat sheet
- Ref: https://codeberg.org/forgejo/forgejo/pulls/2418
2024-02-21 11:55:43 +01:00
Gusted
a4e1851ff2
user: Clarify value of force-push in AGit
- Clarify that if you want to use this parameter the value should be set
to `true` (other values may work, but that can be restricted later).
- Ref: https://codeberg.org/forgejo/forgejo/pulls/2386#issuecomment-1572905
2024-02-19 13:30:51 +01:00
Otto Richter
bd2e86a799 Drop support for Microsoft SQL Server 2024-02-18 20:51:58 +01:00
Panagiotis "Ivory" Vasilopoulos
d12a9fee60 admin/customization: No need to be a developer for custom branding (#427)
Preview: https://forgejo.codeberg.page/@docs_pull_427/docs/next/admin/customization/

---

The previous version of this document insinuated that you need to be
familiar with Forgejo's source code and compile Forgejo from source
for custom branding changes. As of the most recent Forgejo version,
this is not necessarily true, as custom files can be served from
the CustomPath.

Administrators that were not developers therefore dismissed the
other guide and its contents without reading this, and I was one
of them. I thought it would make sense for this file to provide
information on where to put a custom logo. This change does not
fix it (this will be done later), but it will reduce the confusion
for now.

This warning confused me personally and other Forgejo users, as I
had one person tell me IRL that they thought that it was not possible
to serve a custom logo.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/427
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-committed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
2024-02-18 17:22:54 +00:00
François Kooman
29d9296d14 clarify which reverse proxy configuration fields need to be under [security] 2024-02-18 15:29:33 +00:00
Panagiotis "Ivory" Vasilopoulos
6c755e61f4 developer/customization: use example.com example domain 2024-02-18 15:28:10 +00:00
Slatian
4b8db5a048 In issue-pull-request-template documentation, deduplicate contact link name key
The Table under "Contact Link" has two rows labeled `name` with exactly the same content, it should only occur once.
2024-02-18 12:40:05 +00:00