Commit graph

30 commits

Author SHA1 Message Date
Gusted
32485acc13 chore(deps): update dependency prettier to v3.6.2 (#686)
Co-authored-by: woodpecker-bot <woodpecker-bot@obermui.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/686
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
2025-10-20 18:58:07 +02:00
Javier Pérez
875cb34bdc Refactor and fix tables (#627)
# Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## Changed

- Refactor tables to respect `indent_size = 1`.

## Fixed

- Tables with `<tr>` and `<td>` tags in wrong ending order.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/627
Reviewed-by: Bastian Greshake Tzovaras <gedankenstuecke@noreply.codeberg.org>
Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org>
Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
2025-06-16 22:57:17 +02:00
Javier Pérez
e405ae93ae Lint the documentation (#626)
# Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## Removed

- Disable the Markdownlint rule MD024 (`Multiple headings with the same content`).

## Fixed

- Syntax errors in `.markdownlint.yaml`.
- Markdownlint issues:
  - Heading levels should only increment by one level at a time([MD001](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md001.md))
  - Hard tabs ([MD010](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md010.md))
  - Reversed link syntax ([MD011](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md011.md))
  - Dollar signs used before commands without showing output ([MD014](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md014.md))
  - Multiple top-level headings in the same document ([MD025](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md025.md))
  - Trailing punctuation in heading ([MD026](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md026.md))
  - Ordered list item prefix([MD029](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md))
  - Emphasis used instead of a heading([MD036](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md036.md))
  - Fenced code blocks should have a language specified ([MD040](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md040.md))
  - Link fragments should be valid ([MD051](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md051.md))
  - Link text should be descriptive ([MD059](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md059.md))

- Prettier issues.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/626
Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org>
Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
2025-06-14 15:39:01 +02:00
Javier Pérez
c6ac9a9f94 Reduce line length limit and format content (#623)
# Changelog

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## Changed

- Update line length limit from 500 characters to 120 characters.

## Fixed

- Most instances of these lint issues:
  1. Lines longer than 120 characters ([MD013](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md)).
  2. Trailing whitespaces ([MD009](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md009.md)).
  3. Ordered list item prefix ([MD029](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md029.md)).
  4. Bare links ([MD034](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md034.md)).

Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/623
Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org>
Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
2025-06-14 11:38:21 +02:00
Panagiotis "Ivory" Vasilopoulos
3374948e11 Keycloak: Add organization owner note (#604)
Fixes https://codeberg.org/Codeberg/Documentation/issues/541

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/604
2025-05-27 18:31:30 +02:00
Gusted
03342e98ec feat: use Eleventy's image plugin for image transformation (#488)
Use https://www.11ty.dev/docs/plugins/image/ to transform images on build time to avif, webp and jpeg.

Images are moved to `/content/images`.

`<picture>` is no longer needed, the plugin does this automatically.

Remove webp images from the source.

Resolves #152
Resolves #368

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/488
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
2024-11-29 06:12:05 +00:00
Gusted
b66ba78d58 Update links (#484)
Update Gitea link to Forgejo link.

Add GNU link to ignore.

Remove recommendation for Atom (no longer maintained) instead recommend VSCodium.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/484
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
2024-11-27 00:40:44 +00:00
pat-s
74e8925bec add spellchecker (#439)
fix #148

Adds a spell checker via `cspell` and fixes some spelling issues in the docs.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/439
Co-authored-by: pat-s <patrick.schratz@gmail.com>
Co-committed-by: pat-s <patrick.schratz@gmail.com>
2024-06-12 10:20:37 +00:00
pat-s
3cab99a27f
fix liberapay lint issues and broken link 2024-06-12 10:25:04 +02:00
fnetX
c6c7b418e7 Fix typo
Build was failing. This was overlooked, because CI was only added after the PR was last updated.
2024-06-11 11:51:51 +00:00
Igor
0d872ea674 Integrating LiberaPay with Codeberg (#406)
This should resolve issue #327 opened by @n0toose

I have written a little bit of example, how do I see it

Co-authored-by: I <igor@its.rel.pl>
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/406
Co-authored-by: Igor <309631@noreply.codeberg.org>
Co-committed-by: Igor <309631@noreply.codeberg.org>
2024-06-11 11:47:25 +00:00
crapStone
da1b77aa6a Add woodpecker ci & many linters (and their required fixes) (#377)
closes #238

Co-authored-by: pat-s <patrick.schratz@gmail.com>
Co-authored-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/377
Co-authored-by: crapStone <crapstone01@gmail.com>
Co-committed-by: crapStone <crapstone01@gmail.com>
2024-06-11 07:51:22 +00:00
Abdur-Rahman Mansoor
8e0118c9c5
refactor: use american spelling convention and fix grammar 2024-05-24 20:51:47 -04:00
Otto Richter
d5f6f22999 Refresh Contact, Getting Started, Contributing Pages (#394)
Update contact page

Prefer references to Forgejo, more relevant to users

Updates to Getting Started Pages / FAQ
- a lot of content was outdated and generally rewritten or rephrased
- implement procedure for size limits as determined by annual assembly
  2023, see Codeberg-e.V./Discussion#92
- people are sometimes confused wheter you need to be a paying member in
  Codeberg e.V. in order to use the platform

Update improving Codeberg guides
- reduce redundancy in code contribution guide and reference the
  Contributing Issue Tracker instead
- separate (and ideally more appealing) donation page (deserves even
  more love IMHO)
- shorten and strip outdated information

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/394
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: Otto Richter <git@otto.splvs.net>
Co-committed-by: Otto Richter <git@otto.splvs.net>
2024-02-17 22:04:10 +00:00
Panagiotis "Ivory" Vasilopoulos
8386857b1c Use admonition boxes more consistently
- Formatting fixes, relevant text adjustments
- Some more complicated cases (e.g. attribution), as well as outdated
  information that should be removed in a later commit were
  deliberately left unchanged.
- Some minor mistakes (speling, trailing whitespaces, punctuation)
  in the admonition boxes were also fixed.
2023-11-27 07:16:04 +01:00
Lucas Hinderberger
91fbf7a9a0 Replacing tabs with spaces 2023-07-21 21:17:17 +02:00
f0sh
77bfb6cc15 Change all Gitea references to Forgejo, fix #315 (#322)
Where possible, changed all references from Gitea to Forgejo.
Wherever documentation mentions specifically Gitea, it is preserved.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/322
Co-authored-by: f0sh <f0sh@mailbox.org>
Co-committed-by: f0sh <f0sh@mailbox.org>
2023-07-18 00:43:47 +00:00
Oscar Carballal Prego
a25f81e9a2 Improve authentication wording for Matrix integration (#321)
The current documentation fails to specify that the authentication token required a "Bearer" prefix. If a user follows the docs to the letter, it will fail. This patch explains that the user has to add "Bearer" to the token to be able to work.

Co-authored-by: Oscar Carballal Prego <oscar@lareira.digital>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/321
Co-authored-by: Oscar Carballal Prego <oscarcp@noreply.codeberg.org>
Co-committed-by: Oscar Carballal Prego <oscarcp@noreply.codeberg.org>
2023-07-17 09:00:30 +00:00
Panagiotis "Ivory" Vasilopoulos
a9d53ca7cb Add documentation for Keycloak (#316)
Simple guide for using Keycloak with Codeberg based on the instructions
provided by Shane Engelman in Codeberg's Matrix chat.

Co-authored-by: shane <contact@shane.gg>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/316
2023-07-15 20:49:21 +00:00
f0sh
1984032bdd Add improvements to the Documentation according to open issues (#314)
Tried to close some open issues in the issue tracker by submitting the following changes as my first contribution to Codeberg:

 - added list on every section index page, should fix #63
 - added webhooks documentation, should fix #282
 - described behaviour of a limited user profile, should fix #279
 - added further explanation to 2fa section, according to Codeberg/Documentation#268, should fix #268
 - added codeberg badge generator to first-repository description, should fix #39
 - added dns record description to custom-domains, should fix #302
 - added description how to use 2fa with git, should fix #278
 - added and updated repo migration service description, should fix #312

Feedback highly appreciated.

Co-authored-by: f0sh <f0sh@mailbox.org>
Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/314
Co-authored-by: f0sh <f0sh@noreply.codeberg.org>
Co-committed-by: f0sh <f0sh@noreply.codeberg.org>
2023-07-08 16:27:44 +00:00
JakobDev
448fd740df Add Documentation for integrating with Read the Docs (#289)
This adds a Documentation for connecting Codeberg to [Read the Docs](https://readthedocs.org/). English is not my native Language, so there may be a few things that could be written better.

Co-authored-by: René Wagner <rwa@clttr.info>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/289
Co-authored-by: JakobDev <jakobdev@gmx.de>
Co-committed-by: JakobDev <jakobdev@gmx.de>
2023-02-24 19:37:22 +00:00
Otto Richter
2bda61e74d Diverse changes (#189)
a bunch of (typo) fixes, additions, rewordings

Update references

- remove mentions of the master branch, as it's removed for many repos
and might change in the future for others (fixes some dead links)
- remove mentions of moved repos with our official examples
- some on-the-fly additions or rewordings

Close #186 foobar->examples

Co-authored-by: fnetx <git@fralix.ovh>
Co-authored-by: fnetX <git@fralix.ovh>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/189
Co-authored-by: Otto Richter <fnetx@noreply.codeberg.org>
Co-committed-by: Otto Richter <fnetx@noreply.codeberg.org>
2022-01-21 11:36:38 +01:00
n
f4a400d555 Minor tweaks and updates to the Matrix integration article 2021-11-21 20:34:27 +09:00
n
48292a3ffb Remove Gitea Icons shortcode 2021-05-16 20:09:28 +09:00
n
b7aeca27da Remove WIP disclaimer on Integrations category 2021-05-16 16:08:15 +09:00
n
af6dcf11ed Remove note for unencrypted Matrix rooms 2021-05-16 16:07:24 +09:00
n
6f0e575610 Complete Matrix integration guide 2021-05-15 16:19:47 +09:00
n
cc69af91e4 Add Matrix integration 2020-10-17 18:15:48 +09:00
n
484565dc1b Move content from third-party tools article to integrations category 2020-09-03 19:01:19 +09:00
n
2a26119908 Add Integrations Category 2020-09-01 21:20:15 +09:00