0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-24 18:09:26 -05:00
Commit graph

435 commits

Author SHA1 Message Date
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
Alex Fu
f0374b28fe improve install binary documentation
- use useradd instead of adduser
- improve readability of systemd documentation
2024-08-15 20:48:46 +00:00
Radosław Piliszek
622c8244bd git-grep: add git.timeout.grep documentation
Code-PR: forgejo/forgejo#4931
2024-08-15 13:43:12 +02:00
Gusted
6b2a74e82c Remove pause queue step
This step can no longer be done, because this functional was removed
some releases ago.
2024-08-14 17:58:25 +00:00
RobertoMaurizzi
c1aec9211e tell users where to write the variables 2024-08-13 03:43:41 +00:00
TheFox0x7
1f8e663aa2
Revert "OpenTelemetry documentation (#739)"
This reverts commit 202c7aa6a7.
2024-08-08 21:04:51 +02:00
0ko
ded0ad6f85 admin: actualize LOGIN_REMEMBER_DAYS recommendation 2024-08-05 15:37:13 +00:00
matrss
faca0b8961 Fix incorrect referenced number of databases 2024-08-05 15:14:53 +00:00
TheFox0x7
202c7aa6a7 OpenTelemetry documentation (#739)
Documentation for opentelemetry feature https://codeberg.org/forgejo/forgejo/pulls/3972

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/739
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: TheFox0x7 <thefox0x7@gmail.com>
Co-committed-by: TheFox0x7 <thefox0x7@gmail.com>
2024-08-05 06:05:35 +00:00
dragon
4a627a2fec add arch package doc (#791)
This is the documentation for PR https://codeberg.org/forgejo/forgejo/pulls/4785.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/791
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
Co-authored-by: dragon <explodingfkl@gmail.com>
Co-committed-by: dragon <explodingfkl@gmail.com>
2024-08-05 04:58:09 +00:00
0ko
2515c7ef1f admin: update attachment.ALLOWED_TYPES with .webp 2024-08-04 21:02:44 +00:00
0ko
359d69f279 admin: sync i18n language lists with Forgejo code 2024-08-04 19:06:21 +00:00
Panagiotis "Ivory" Vasilopoulos
85fbfe4885 developer/customization: improve CustomPath hints
Additionally, the notice for restarting Forgejo was rewritten
to be more explicit.
2024-08-02 15:06:05 +00:00
Panagiotis "Ivory" Vasilopoulos
7cc3393317 admin: cheat sheet, improve USER_LOCATION_MAP_URL 2024-08-02 11:39:38 +02:00
mahlzahn
ce7ca34bcb Fix label application instructions 2024-07-31 22:47:28 +00:00
Earl Warren
76819bacec
developer: *.next are at https://code.forgejo.org/infrastructure/k8s 2024-07-31 06:52:56 +02:00
Massimiliano Adamo
abbc414b1f add haproxy documentation (#781)
- add documentation to use haproxy
- add documentation to use unix socket
- add warning about NGINX binary distributions

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/781
Reviewed-by: thefox <thefox@noreply.codeberg.org>
Co-authored-by: Massimiliano Adamo <maxadamo@gmail.com>
Co-committed-by: Massimiliano Adamo <maxadamo@gmail.com>
2024-07-28 18:42:41 +00:00
senekor
cbb50df101 admin: fix typo 2024-07-26 18:12:14 +00:00
Earl Warren
5df0c12686 admin: cli: --keep-labels is a new option 2024-07-24 09:18:13 +00:00
Earl Warren
617a06b104 developer: dependencies: how to mention changes in the release notes 2024-07-24 09:18:13 +00:00