Commit graph

63 commits

Author SHA1 Message Date
mukunda katta
64e97c1190 docs: clarify HTTPS auth with 2FA (#784)
## Summary
- clarify that HTTPS Git auth should use an access token as the password when 2FA is enabled
- update both the first repository guide and the CLI clone/commit guide for consistency

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/784
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
2026-05-05 10:41:45 +02:00
Dave Anselmi
8215c254bc Move duplicate article list snippets to shortcode. (#780)
Closes #335.

This is my first attempt coding for eleventy/liquid so I'd be happy to get feedback on making the code cleaner or more idiomatic, or just more like the Codeberg style.

Co-authored-by: David Anselmi <danselmi@intecrowd.com>
Co-authored-by: Gusted <postmaster@gusted.xyz>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/780
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
2026-04-27 14:36:08 +02:00
leeroyjankins
047aa55ba0 Recommend forgejo-cli instead of codeberg-cli in the section on CLI clients (#773)
Since [codeberg-cli](https://codeberg.org/Aviac/codeberg-cli) has been discontinued, update the section on CLI clients to recommend forgejo-cli, which the codeberg-cli maintainer endorses.

Given the endorsement, I presume that it's worth recommending in the docs, even though the project is relatively young. Having used it myself, I can vouch for it.

I wrote a brief overview of forgejo-cli to contrast it slightly with `tea`.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/773
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
Co-authored-by: leeroyjankins <hatemail@jank.wtf>
Co-committed-by: leeroyjankins <hatemail@jank.wtf>
2026-04-09 11:00:42 +02:00
Gusted
ad9e3c53e0 Make linters happy (#723)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/723
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
2025-12-19 02:12:14 +01:00
TalpaEuropaea
eec6e02abf doc: fixed typo in content/git/reduce-size.md (#717)
Added a missing "to".

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/717
Reviewed-by: Bastian Greshake Tzovaras <gedankenstuecke@noreply.codeberg.org>
Co-authored-by: TalpaEuropaea <talpaeuropaea@noreply.codeberg.org>
Co-committed-by: TalpaEuropaea <talpaeuropaea@noreply.codeberg.org>
2025-12-08 16:23:43 +01:00
Javier Pérez
941914f698 Fix lint issues (#629)
# Changelog

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

## Fixed

- Lint issues:
  - Line length ([MD013](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md013.md)).
  -  Heading levels should only increment by one level at a time ([MD001](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md001.md)).
  - Link fragments should be valid ([MD051](https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md051.md)).
---

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/629
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: Javier Pérez <walpo@noreply.codeberg.org>
Co-committed-by: Javier Pérez <walpo@noreply.codeberg.org>
2025-11-21 12:35:05 +01:00
Bastian Greshake Tzovaras
43af756a75 Add docs on how to reduce git repo size/remove files (#639)
Given the plan to enable the storage quotas at some point in the future, instructions for how to reduce the size of git repos will become more relevant (and indeed, this has been a recurring question that came up on Codeberg, Matrix etc since announcing the quotas).

Building on @aral's draft in #418 I've gone ahead and took a stab at adding such a docs page, which hopefully helps outline the approach with enough warnings 😆

Closes #418

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/639
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: Bastian Greshake Tzovaras <bgreshake@googlemail.com>
Co-committed-by: Bastian Greshake Tzovaras <bgreshake@googlemail.com>
2025-07-12 16:10:52 +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
Seyed Mohamad Amin Modaresi
95ef240390 explain enabling repository releases (#597)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/597
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-by: Robert Wolff <mahlzahn@posteo.de>
Co-authored-by: Seyed Mohamad Amin Modaresi <modaresisofthard@proton.me>
Co-committed-by: Seyed Mohamad Amin Modaresi <modaresisofthard@proton.me>
2025-06-10 18:51:17 +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
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
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
Andre601
7a9017e760 Fix broken link for Git LFS Migrate Man page (#404)
The URL for the man page of Git LFS migrate was broken. This is fixed in this PR.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/404
Co-authored-by: Andre601 <github@andre601.ch>
Co-committed-by: Andre601 <github@andre601.ch>
2024-03-11 12:19:54 +00:00
Leo Heitmann Ruiz
364a316007 Remove unnecessary mention of Git Bash (#400)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/400
Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Co-authored-by: Leo Heitmann Ruiz <eo@noreply.codeberg.org>
Co-committed-by: Leo Heitmann Ruiz <eo@noreply.codeberg.org>
2024-03-06 10:19:01 +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
Panagiotis "Ivory" Vasilopoulos
5d457efc06 Clean up 'Clone & Commit via CLI' guide (#325)
* Fix typos
* Simplify language
* Increase clarity as to whether the CLI tools are official
* Make language slightly more formal
* Gaps between headers and content

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/325
2023-07-18 14:29:05 +00: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
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
RobWalt
9c4533497b update codeberg-cli section with new binary name (#299)
We noticed that there is an application with the name `cod` already in available as a package in many distros and decided to rename the binary to `berg`. This PR just updates the section about `codeberg-cli` to use the new binary name.

Co-authored-by: RobWalt <robwalter96@gmail.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/299
Co-authored-by: RobWalt <robwalt@noreply.codeberg.org>
Co-committed-by: RobWalt <robwalt@noreply.codeberg.org>
2023-03-20 08:33:15 +00:00
n0toose
447946f70b Clarify that Codeberg API can create new releases (#297)
This PR was created in a hurry -- it was created after a person in the Codeberg Matrix room asked for an explicit clarification.

Co-authored-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/297
Co-authored-by: n0toose <git@n0toose.net>
Co-committed-by: n0toose <git@n0toose.net>
2023-03-18 14:42:36 +00:00
RobWalt
4c425e13a4 Mentioning codeberg-cli tool (#285)
Co-authored-by: RobWalt <robwalter96@gmail.com>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/285
Co-authored-by: RobWalt <robwalt@noreply.codeberg.org>
Co-committed-by: RobWalt <robwalt@noreply.codeberg.org>
2023-02-24 20:14:28 +00:00
Jeremy
d42e22f64c Fixed English mistakes 2022-12-24 09:48:23 +00:00
fpare
d34e73a2b6 add suggestion to use SSH to avoir entering password every time 2022-11-29 17:18:29 +00:00
fpare
7a9528cfff Revert "add suggestion to use SSH to avoir entering password every time"
This reverts commit a4e17f1ad1.
2022-11-29 17:18:29 +00:00
narF
3cac95303e add suggestion to use SSH to avoir entering password every time 2022-11-29 17:18:29 +00:00
jklippel
f7e3e24d3a added line to explain that a git push is necessary (#257)
add line to explain that a git push is necessary

Fixes #242

Co-authored-by: Jan Klippel <c0d3b3rg@kl1pp3l.de>
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/257
Co-authored-by: jklippel <jklippel@noreply.codeberg.org>
Co-committed-by: jklippel <jklippel@noreply.codeberg.org>
2022-08-06 15:39:35 +02:00
Jeremy
6841251d1a Fix git/* 2022-07-26 21:46:39 +02:00
Jan Klippel
6503ebfd33 changes after review 2022-06-16 21:20:38 +02:00
Jan Klippel
a99d6f424e Format notes and caveats
Format notes and caveats according to style guide
2022-06-16 21:20:38 +02:00
Jan Klippel
2460e87199 Changes after review. 2022-06-16 21:20:38 +02:00
Jan Klippel
1726ed1620 LFS-documentation
Initial version of an article on LFS

Fixes: #133
2022-06-16 21:20:38 +02:00
mutluyuz
9e3acf9f44 Tags need to be pushed to the remote target (#228)
Add a note that tags need to be pushed to the remote target.

Please let me know, if you have any suggestions to improve the wording and this paragraph.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/228
Co-authored-by: mutluyuz <mutluyuz@noreply.codeberg.org>
Co-committed-by: mutluyuz <mutluyuz@noreply.codeberg.org>
2022-05-10 08:09:38 +02:00
Jan Klippel
ca68a77a76
add documentation of .gitignore
Add documentation of .gitignore to reduce clutter in Codeberg.

Fixes #117
2022-04-14 12:32:37 +02: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
Gerhard Beck
aaf58c97c4 Move Instructions on Creating a Release (#163)
Moving "releases in Codeberg" as discussed in https://codeberg.org/Codeberg/Documentation/issues/151

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/163
Co-authored-by: Gerhard Beck <gerhard.beck@elkb.de>
Co-committed-by: Gerhard Beck <gerhard.beck@elkb.de>
2021-08-20 10:09:04 +02:00
n
170914185d Add anchor links to headings (#159)
This PR adds anchor links to any markdown headings. It also replaces any hacky workarounds used previously.

Closes #83.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/159
Co-authored-by: n <n@noreply.codeberg.org>
Co-committed-by: n <n@noreply.codeberg.org>
2021-08-09 11:59:36 +02:00
Ajay Raghavan
9501efb4d1 Changed structure of 'Configuring Git' 2021-07-20 15:57:35 +05:30
Lucas Hinderberger
1557f2b3d8 Fixing section order collisions 2021-07-11 15:01:01 +02:00
n
40611df5ec bash --> shell 2021-06-16 21:16:59 +09:00
n
bf46e692f8 Fix typo 2021-06-15 19:43:23 +09:00
n
5ea6b723e8 Unify SSH and HTTP clone & commit articles (#129) 2021-06-15 19:21:47 +09:00
fnetx
fa7a04afa7
Make all Git and Codeberg mentions uppercase 2021-05-29 15:09:43 +02:00
René Wagner
09659373e7
ssh usage: cosmetic changes 2021-05-29 10:14:36 +02:00
René Wagner
d545fd3dbc
adjust wording on hint to ssh key setup 2021-05-28 20:14:37 +02:00
René Wagner
e26265cf78
short explanation why to use SSH 2021-05-28 19:53:31 +02:00
n
b82d39de3e JohnDoe --> Knut 2021-05-28 08:56:16 +09:00
fnetx
9c2bc355db
Correct links to web & ssh clone articles 2021-05-27 23:31:19 +02:00
René Wagner
b155792237
cleanup git via ssh 2021-05-27 21:38:11 +02:00