mirror of
https://codeberg.org/Codeberg/Documentation.git
synced 2026-06-16 05:13:54 -07:00
c6ac9a9f94
# 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>
26 lines
1.4 KiB
Markdown
26 lines
1.4 KiB
Markdown
---
|
|
eleventyNavigation:
|
|
key: HowToMakeScreenshots
|
|
title: How to make screenshots for Codeberg Documentation?
|
|
parent: ImprovingTheDocumentation
|
|
order: 15
|
|
---
|
|
|
|
Screenshots for Codeberg Documentation should follow the guidelines explained in
|
|
[Kesi Parker's excellent article](https://medium.com/technical-writing-is-easy/screenshots-in-documentation-27b45342aad8).
|
|
|
|
They should be created using the "Knut" demo account on `codeberg-test.org`. If you're a regular, trusted contributor to
|
|
Documentation, you can find its credentials in a private repository in the `knut` organization on `codeberg.org`.
|
|
|
|
Otherwise, feel free to request screenshots being added when merging your PR. For that, please include
|
|
`TODO SCREENSHOT [of foo]` in your article.
|
|
|
|
On the technical side, screenshots should ideally be created in PNG and WebP or JPEG for photographs.
|
|
Screenshots should be in a large enough resolution so that text is clearly readable and their filenames should follow
|
|
Codeberg Documentation's [naming conventions](/improving-documentation/docs-contributor-faq#how-should-files-be-named%3F).
|
|
|
|
Please put screenshots under `content/images/[section]/[article]/...` where `[section]` and `[article]` are the
|
|
kebab-cased names of the section or your article, respectively.
|
|
|
|
Codeberg Documentation encodes images to WebP, JPEG and PNG format on build time, in order to increase page loading
|
|
speed and reduce traffic.
|