Commit graph

20 commits

Author SHA1 Message Date
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
crystal
9e4e00d7d0 improve custom domain examples (#557)
- remove codeberg.page from .domains, it's redundant, the pages-server
  does not validate the .domains file for codeberg.page domains
- add information for www-apex redirects to apex examples

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/557
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: crystal <crystal@noreply.codeberg.org>
Co-committed-by: crystal <crystal@noreply.codeberg.org>
2025-10-30 17:05:41 +01:00
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
kevinhikaruevans
a4e80b85a7 fix: do not suggest both an A and CNAME record (#671)
I think this was a copy-paste error. But you cannot have both A and CNAME records on the same name. Only A/AAAA/TXT are the records needed here.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/671
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: kevinhikaruevans <kevinhikaruevans@noreply.codeberg.org>
Co-committed-by: kevinhikaruevans <kevinhikaruevans@noreply.codeberg.org>
2025-09-14 13:28:09 +02:00
Kilian Koeltzsch
83ac61e9a8 add warning about pages for repositories with a dot in the name (#670)
Hi,

coming from https://codeberg.org/Codeberg/pages-server/issues/512, this adds a warning that repos with dots in the name can cause issues when trying to set up a custom domain.

I'm not sure if the wording here fits the existing docs, or if hints like this fit in the docs at all, but I wanted to open this as a suggestion nonetheless :)

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/670
Reviewed-by: Bastian Greshake Tzovaras <gedankenstuecke@noreply.codeberg.org>
Co-authored-by: Kilian Koeltzsch <me@kilian.io>
Co-committed-by: Kilian Koeltzsch <me@kilian.io>
2025-09-12 15:32:49 +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
crystal
9a55f7bf8b update Codeberg Pages IP addresses (#556)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/556
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: crystal <crystal@noreply.codeberg.org>
Co-committed-by: crystal <crystal@noreply.codeberg.org>
2025-04-23 13:43:54 +00:00
Gusted
87c587f7bc Add CAA record value (#486)
Resolves #469

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/486
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
2024-11-27 02:49:34 +00:00
r12t
24dde65bd4 Fix custom dns CNAME record (#457)
Fixes #456

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/457
Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Co-authored-by: r12t <r12t@noreply.codeberg.org>
Co-committed-by: r12t <r12t@noreply.codeberg.org>
2024-07-29 08:02:10 +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
niko4u
1b84cd41a4 Minor rewording (#428)
Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/428
Reviewed-by: Patrick Schratz <pat-s@noreply.codeberg.org>
Co-authored-by: niko4u <niko4u@noreply.codeberg.org>
Co-committed-by: niko4u <niko4u@noreply.codeberg.org>
2024-06-12 08:57:35 +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
Sammy Hori
8bd521c7f6 Codeberg Pages: Add warning for setting up records on some registrars (#431)
Many users setting up Codeberg Pages that use the records have limited experience with DNS.

Therefore, adding this warning to make it clear what they may need to be entering into
their records will likely save them time and effort in troubleshooting why their page may
not be loading correctly.

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/431
Co-authored-by: Sammy Hori <sammyhori@noreply.codeberg.org>
Co-committed-by: Sammy Hori <sammyhori@noreply.codeberg.org>
2024-06-09 14:23:36 +00:00
Gusted
adf276bea6
pages: Correct statement about CAA record
- Resolves https://codeberg.org/Codeberg/Documentation/issues/413
2024-03-23 22:15:22 +01:00
Mark Pitblado
8a32b7cec9 Pages: General typo and grammatical fixes (#391)
Main changes include switching language from ISP to domain registrar, and standardization around the phrase "Codeberg Pages".

Signed-off-by: Mark Pitblado <mark@pitblado.me>

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/391
Reviewed-by: crapStone <codeberg@crapstone.dev>
Co-authored-by: Mark Pitblado <mark-pitblado@noreply.codeberg.org>
Co-committed-by: Mark Pitblado <mark-pitblado@noreply.codeberg.org>
2024-02-09 08:18:50 +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
Andre601
b234b71bb7 Create new admonition boxes (#337)
Related issue: https://codeberg.org/Codeberg/Documentation/issues/330

This is my attempt at adding admonition-like boxes to the documentation. The goal is to make important stuff stand out more (especially warnings and alike).

The system uses a custom `<admonition>` box which allows classes for further customization. I.e. `<admonition class="warning">` to display a warning box.

I first wanted to make individual boxes (`<warning>`, `<note>`, ...) but decided against it, as it would've created a lot of duplicate CSS.

The CSS is designed in such a way that the first paragraph of the box is made bold (font-weight 700) while any subsequent ones are not.

The following forms of admonitions are included:
- Info (default)
- Note
- Tip
- Warning

Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/337
Co-authored-by: Andre601 <github@andre601.ch>
Co-committed-by: Andre601 <github@andre601.ch>
2023-09-18 15:17:17 +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