0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-12-24 22:32:43 -05:00
Commit graph

750 commits

Author SHA1 Message Date
Thorben Günther
385990b2c3 cheat-sheet: Improve delete_old_actions description
This matches the text in the web interface.

The old description can be easily mistaken for handling "Forgejo Actions".
2024-10-21 22:18:09 +00:00
Kwonunn
0881419f4b fix: wrong header indent 2024-10-21 14:47:06 +02:00
marcus doescher
eb58d4d121 change required go version to 1.23 (#897)
Hi, I just encountered this small issue when trying to build forgejo.
I could update this in other places as well if needed, but for now I assumed the `next` branch would be a good start.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/897
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: marcus doescher <deh.marcus@posteo.net>
Co-committed-by: marcus doescher <deh.marcus@posteo.net>
2024-10-17 17:39:02 +00:00
apoorv569
bd7373c0d8 Change internal ssh port for rootless image. (#895)
Change internal ssh port for rootless image to 2222 as the rootless image has ssh running on port 2222.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/895
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: apoorv569 <apoorv569@noreply.codeberg.org>
Co-committed-by: apoorv569 <apoorv569@noreply.codeberg.org>
2024-10-17 16:22:30 +00:00
Earl Warren
6eb5c6fbf3
contributor: release schedule for v9.0 and v10.0
v9.0 is compatible with Gitea v1.22 because Gitea v1.23 branch is not
cut yet and it won't be released in the next few days.
2024-10-16 05:28:29 +02:00
Otto Richter
bfd9913680 admin: Initial quota docs 2024-10-15 23:15:24 +02:00
Alex Fu
c132e28383 add sh syntax highlighting to all shell code blocks 2024-10-12 06:22:48 -04:00
lynoure
c5ad84aea4 Made it a little bit easier to get the latest version of the runner and verify the file 2024-10-10 15:33:51 +00:00
0ko
47fa1d791f contributor: localizatoin: fix merge instruction 2024-10-05 14:45:11 +05:00
Radosław Piliszek
bf81d30d6e Document gotestsum use
Depends-On: https://codeberg.org/forgejo/forgejo/pulls/5249
2024-10-04 14:08:57 +00:00
Ainsley Ellis
8418b8bd50 Fix broken links 2024-10-02 22:34:01 -04:00
0ko
35799093e4 contributor: remove mentions of decommissioned mirrors 2024-10-01 20:03:36 +05:00
0ko
f45dc35837 user: arch package: fix typo, fix wrong link 2024-09-29 06:42:54 +00:00
0ko
bbea55ea29 contributor: localization admin: further clarify squsah-merges 2024-09-28 15:00:56 +05:00
0ko
fe7d2b2459 contributor: localization admin: clarify squash-merge, use bold text for button names (#873) 2024-09-27 12:38:42 +00:00
ExplodingDragon
577e8791c3
supprt arch delete by arch 2024-09-27 09:44:59 +08:00
Otto Richter
8f373ae546 Sort instructions for specific Forgejo/Gitea/Gogs version
... in one place instead of scattering throughout the document
2024-09-24 20:21:08 +02:00
Kwonunn
d88ef00889 Fix copying mistake 2024-09-23 07:58:10 +00:00
Kwonunn
9567aff03a Improve runner installation instructions (#860)
This PR rewrites the runner installation instructions, with the following changes:

- deduplicate instructions as much as possible
- explicitly instruct to create a separate user for the runner
- reword the label explanations
- split the instructions for administrating the actions feature from the installation guide for the Forgejo Runner
- add instructions for setting up the runner as a systemd service

https://forgejo.codeberg.page/@docs_pull_860/docs/next/admin/actions
https://forgejo.codeberg.page/@docs_pull_860/docs/next/admin/runner-installation/
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/860
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Kwonunn <kwonunnx@gmail.com>
Co-committed-by: Kwonunn <kwonunnx@gmail.com>
2024-09-20 03:49:01 +00:00
0ko
ac0870ad33 admin: remove Windows-specific note (#866)
Forgejo doesn't run on Windows, so this part is just a noise.

Ref: https://codeberg.org/forgejo/forgejo/issues/712.
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/866
Reviewed-by: Otto <otto@codeberg.org>
Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
2024-09-19 17:03:20 +00:00
Earl Warren
f58b896f32 contributor: infrastructure: move to a dedicated repository
The https://code.forgejo.org/infrastructure organization was created
recently to host infrastructure resources. The documentation should go there
instead of the Forgejo documentation.
2024-09-17 06:02:23 +00:00
Earl Warren
1a72849b87 user: OAuth2 section title typo 2024-09-16 11:58:33 +00:00
Gusted
ef75a59038 Remove CLI documentation in config cheat sheet
The configuration cheat sheet isn't the canonical documentation for the
CLI and this particular bit has no relation to `ENABLE_PPROF` setting
anymore.
Resolves forgejo/forgejo#5268
2024-09-16 11:57:52 +00:00
Daniel Mowitz
4bf0ad1856 Removed a line of configuration that turned out to be redundant. 2024-09-14 19:09:22 +00:00
Daniel Mowitz
e11f4a3f88 Added a link to a blog post about the emacs go mode. 2024-09-14 19:09:22 +00:00
Daniel Mowitz
9c6b25dbf3 Added documentation for Emacs as a development environment. 2024-09-14 19:09:22 +00:00
Earl Warren
8fdbb80b11 contributor: infrastructure: forward ssh with nginx instead of nft
It simplifies the setup instructions and the skill requirements for
devops to use nginx to forward all ports instead of a mix of nftables
& nginx.

Also supports IPv6 and not just IPv4.
2024-09-11 12:08:19 +00:00
Otto Richter
10dff2ee1a simplify installation quickstart
Goal: prevent situations like https://codeberg.org/forgejo/forgejo/issues/5278 where users run Forgejo without reading the detailed setup guide.
2024-09-11 10:11:50 +00:00
0ko
6f34126bee contributor: base localization: document form labels style 2024-09-10 21:59:49 +05:00
Otto Richter
f25e842fec Rework contributor test instructions with new developers in mind 2024-09-09 12:02:10 +00:00
Malte Jürgens
830595982f
Add Tags and Releases page
This has been adapted from
https://codeberg.org/Codeberg/Documentation/src/branch/main/content/git/using-tags.md,
and updated to document the changes from
https://codeberg.org/forgejo/forgejo/pulls/1445.

Co-authored-by: n <n@noreply.codeberg.org>
Co-authored-by: Gerhard Beck <gerhard.beck@elkb.de>
Co-authored-by: Jeremy <jeremytbaxter@protonmail.com>
Co-authored-by: Jeremy <jtbx@duck.com>
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: William Davis <unbeatable-101@noreply.codeberg.org>
Co-authored-by: crapStone <crapstone01@gmail.com>
Co-authored-by: f0sh <f0sh@mailbox.org>
Co-authored-by: fnetx <git@fralix.ovh>
Co-authored-by: mutluyuz <mutluyuz@noreply.codeberg.org>
Co-authored-by: n0toose <git@n0toose.net>
2024-09-08 19:39:34 +02:00
yonas
be2d4d2c8c
Update Docker installation instructions to use v8 2024-09-07 07:42:43 -04:00
Otto Richter
182007a5a5 Update binary installation instructions 2024-09-05 13:23:31 +02:00
Otto Richter
3d46045045 Update database preparation guide
- it is related to installation instructions
- mention SQLite in the guide
- reduce the complexity of the guide (I think we don't need to cover all the details here, there are better guides available)
2024-09-05 13:23:31 +02:00
Otto Richter
a5d81cda7d Update logging section in cheat sheet
- adds journald information (also see https://codeberg.org/forgejo/docs/pulls/514)
- improves internal references
2024-09-05 08:33:25 +00:00
Joaquin Dominguez
7fd780c085 updated container file to remove timezone and localtime volume 2024-09-04 23:07:13 +00:00
Joaquin Dominguez
e2dd73e88b updated installation-docker.md file with Podman instructions 2024-09-04 23:07:13 +00:00
Mai-Lapyst
000ca5ab42 Reword how custom values for the shell prop work 2024-09-04 23:05:30 +00:00
Mai-Lapyst
5d576d8b3c Document better how the shell prop in steps work 2024-09-04 23:05:30 +00:00
Guiorgy
45ace87e6f removed the obsolete version element
Source: 581430f73b/content/reference/compose-file/version-and-name.md (version-top-level-element-obsolete)
2024-09-04 23:05:15 +00:00
Otto Richter
f0d90ef335 sync admin command-line docs 2024-09-04 22:59:39 +00:00
Ivan Shapovalov
0a8830c30b admin: logging-documentation: document journald support
As of forgejo/forgejo#2869, console logging implements three adaptations
for running forgejo under systemd/journald:

- forgejo learned to emit printk-style log level prefixes that are
  picked up by journald and saved as the severity level of this line
  (e.g., `<3>some text\n` means that "some text" will be saved as an
   error entry);
- forgejo learned a new pseudo-flag "journaldflags" which is supposed to
  replace "stdflags" when running under journald to reduce log clutter
  (specifically, it removes date/time from log entries since the
   time information is automatically saved by journald and displayed by
   journalctl, and replaces the textual log level by the above-described
   machine-parsable log level prefix);
- finally, forgejo will try to automatically detect whether it is
  running under journald by parsing `$JOURNAL_STREAM` environment
  variable and use "journalflags" as default flags if that is the case).

Document those.

Signed-off-by: Ivan Shapovalov <intelfx@intelfx.name>
2024-09-04 21:56:49 +00:00
Ivan Shapovalov
13be414998 admin: logging-documentation: clarify COLORIZE setting
Signed-off-by: Ivan Shapovalov <intelfx@intelfx.name>
2024-09-04 21:56:49 +00:00
mahlzahn
7c5ef2e7e2 Fix location of gitconfig user file 2024-09-04 21:44:56 +00:00
Sai Nane
facf05de24 admin: Reword, format consistency
This changes terminal command blocks to always use the multiline formatting,
as the leading octothorpe looks very strange when displaying a command inline.
Two consecutive inline commands at the start was very difficult to read in the
generated html. See:
https://forgejo.org/docs/latest/admin/installation-binary/

`HTTP_PORT` has been highlighted as a code term. This also means we don't need
to worry about another underscore in the same line being added and interpreted
as syntax.

Simplifies and fixes sentence structure in a few places. I've seen arguments
for and against the use of "just" in technical writing, but I think here it's
better without?

Reworded some paragraphs so that the command comes at the end.
2024-08-28 11:08:34 +00:00
Gusted
0fe4007f5c Add documentation for pushmirror via SSH
- Refs: forgejo/forgejo#4819
2024-08-26 08:06:56 +00:00
Otto Richter
64fe34712f Update contributing sections (#821)
Rename Developer to Contributor guide
- I believe this sounds more inclusive and likely improves the diversity of contributors.
Separate translation section
clarify external resources
Add links to UI/UX and user research repos
Separate issue tracker and discussions
- I imagine this is part of the confusion for people who report bugs to the discussion tracker.
Add welcome section

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/821
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: Otto Richter <git@otto.splvs.net>
Co-committed-by: Otto Richter <git@otto.splvs.net>
2024-08-25 16:15:48 +00:00
Christoph Heiss
3de284c2c9
admin: cheat-sheet: fix SCHEDULE description for extended cron tasks
Signed-off-by: Christoph Heiss <christoph@c8h4.io>
2024-08-24 17:22:18 +02:00
0ko
c9eba3bf30 user: actions: replace manpage provider for crontab 2024-08-21 20:58:41 +05:00
Radosław Piliszek
e82255b9bf agit: replace the "complex" example
There was a lot of false information in that section and the
examples did not do what was described in the text.

This change extracts the perhaps-useful reminder that push still
behaves like push and allows to specify arbitrary local references.

Some points to note (which were wronged previously):

* refspec for push has the dst part optional, not the other way
  around (and it's thus either `src` or `src:dest` in syntax)
* HEAD always points to the checked-out reference, so all examples
  were still pushing the checked-out reference
2024-08-16 12:25:34 +00:00