Additional information about screenshots and example repos
This commit is contained in:
parent
6fad43db80
commit
6b4ec4bcda
1 changed files with 9 additions and 0 deletions
|
@ -71,10 +71,19 @@ There are a number of exceptions to the rule above:
|
|||
- For bugfixes and other small and non-controversial changes, the process is much simplified - here it is enough for one collaborator to green-light and merge the changes. If you're already a collaborator yourself, feel free to merge right away (after sufficient testing, that is).
|
||||
- For changes that are critical, e.g. ones that might legally affect Codeberg e.V., the chairperson of Codeberg e.V. will need to approve of the changes as well
|
||||
|
||||
### Where to create example repositories?
|
||||
Please create example repositories for the Documentation in the `knut` organization on `codeberg-test.org`.
|
||||
|
||||
If you do not have permissions for that, feel free to ask [in the issue tracker](https://codeberg.org/Codeberg/Documentation/issues).
|
||||
|
||||
### How to make screenshots for Codeberg Documentation?
|
||||
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 available in both the webP
|
||||
and PNG formats (webP and JPEG for photographs), they should be in a large enough resolution so that text is clearly
|
||||
readable and their filenames should follow Codeberg Documentation's [naming conventions](#file-naming-conventions).
|
||||
|
|
Loading…
Reference in a new issue