Codeberg Documentation - Contributing screenshots #800

Open
opened 2026-06-03 19:24:59 +02:00 by jarrodlovas · 2 comments
Contributor

I am looking to get involved in contributing to Codeberg and starting with documentation is low hanging fruit and something where most beginners will start.

I was looking at issue 240 and there was a reference to this article in the documentation How to make screenshots for Codeberg Documentation?.

It outlines using codeberg-test.org using a Knut demo account in the test environment for generating screenshots.
Documentation is something most beginners generally start with when starting to dive into the world of contributing to opensource projects.

I was hoping to work with the Codeberg team to discuss a pathway forward to either:

  1. Update this article, removing that requirement
  2. Discussion on how to structure solution that enables beginners to contribute screenshots to the documentation without these kinds of barriers, hopefully enabling more people to start contributing to this project.
  3. Expanding the documentation with a screenshot contribution framework with guidelines of screenshot contribution, removing the need for potentially needing to generate the screenshots using a test environment to begin with.

The primary idea behind this issue is how can we enable beginners to get involved and contribute to the documentation which includes being able to provide screenshots.

I am looking to get involved in contributing to Codeberg and starting with documentation is low hanging fruit and something where most beginners will start. I was looking at [issue 240](https://codeberg.org/Codeberg/Documentation/issues/240) and there was a reference to this article in the documentation [How to make screenshots for Codeberg Documentation?](https://docs.codeberg.org/improving-documentation/screenshots/). It outlines using `codeberg-test.org` using a Knut demo account in the test environment for generating screenshots. Documentation is something most beginners generally start with when starting to dive into the world of contributing to opensource projects. I was hoping to work with the Codeberg team to discuss a pathway forward to either: 1. Update this article, removing that requirement 2. Discussion on how to structure solution that enables beginners to contribute screenshots to the documentation without these kinds of barriers, hopefully enabling more people to start contributing to this project. 3. Expanding the documentation with a screenshot contribution framework with guidelines of screenshot contribution, removing the need for potentially needing to generate the screenshots using a test environment to begin with. The primary idea behind this issue is how can we enable beginners to get involved and contribute to the documentation which includes being able to provide screenshots.
Contributor

A question for a Codeberg maintainer: is there anything special about the "knut" Codeberg that differentiates it from vanilla Forgejo, apart from branding? If so, would there be a straightforward process by which a local Forgejo instance could be made to serve the same purpose, for "untrusted" contributors?

@jarrodlovas wrote in #800 (comment):

The primary idea behind this issue is how can we enable beginners to get involved and contribute to the documentation which includes being able to provide screenshots.

Regarding the blog post linked from the article you reference, may I humbly suggest ksnip for screenshots and annotations. It's a GPL-licensed Qt app and releases are provided for all three major OSes. I still mourn the loss of Skitch, the macOS-only screenshot tool par excellence, but ksnip is an adequate replacement for Skitch's basic functionality. One significant downside, though, is that the annotations become merged with the image after saving.

A question for a Codeberg maintainer: is there anything _special_ about the "knut" Codeberg that differentiates it from vanilla Forgejo, apart from branding? If so, would there be a straightforward process by which a [local Forgejo instance](https://forgejo.org/docs/latest/admin/installation/docker/#docker) could be made to serve the same purpose, for "untrusted" contributors? @jarrodlovas wrote in https://codeberg.org/Codeberg/Documentation/issues/800#issue-5540435: > The primary idea behind this issue is how can we enable beginners to get involved and contribute to the documentation which includes being able to provide screenshots. Regarding the [blog post linked from the article you reference](https://medium.com/technical-writing-is-easy/screenshots-in-documentation-27b45342aad8), may I humbly suggest [ksnip](https://github.com/ksnip/ksnip) for screenshots and annotations. It's a GPL-licensed Qt app and releases are provided for all three major OSes. I still mourn the loss of [Skitch](https://www.matthewtonkin.com/skitch), the macOS-only screenshot tool _par excellence_, but ksnip is an adequate replacement for Skitch's basic functionality. One significant downside, though, is that the annotations become merged with the image after saving.
Owner

Sorry for not responding earlier!

@ernstki wrote in #800 (comment):

A question for a Codeberg maintainer: is there anything special about the "knut" Codeberg that differentiates it from vanilla Forgejo, apart from branding

I don't know a knut Codeberg theme, that should be just the Codeberg theme:

image

@ernstki wrote in #800 (comment):

If so, would there be a straightforward process by which a local Forgejo instance could be made to serve the same purpose, for "untrusted" contributors?

Yes, run https://codeberg.org/Codeberg-Infrastructure/forgejo/ and in the app.ini have:

THEMES = codeberg-auto, codeberg-light, codeberg-dark, forgejo-auto, forgejo-light, forgejo-dark, gitea-auto, gitea-light, gitea-dark, forgejo-auto-deuteranopia-protanopia, forgejo-light-deuteranopia-protanopia, forgejo-dark-deuteranopia-protanopia, forgejo-auto-tritanopia, forgejo-light-tritanopia, forgejo-dark-tritanopia

FWIW, we also could like grant someone motivated access to https://codeberg.org/knut and simply use codeberg.org to make screenshots.

Sorry for not responding earlier! @ernstki wrote in https://codeberg.org/Codeberg/Documentation/issues/800#issuecomment-18106151: > A question for a Codeberg maintainer: is there anything _special_ about the "knut" Codeberg that differentiates it from vanilla Forgejo, apart from branding I don't know a knut Codeberg theme, that should be _just_ the Codeberg theme: ![image](/attachments/80d4c4bf-a7db-48bf-8d8f-98931a2427f7) @ernstki wrote in https://codeberg.org/Codeberg/Documentation/issues/800#issuecomment-18106151: > If so, would there be a straightforward process by which a [local Forgejo instance](https://forgejo.org/docs/latest/admin/installation/docker/#docker) could be made to serve the same purpose, for "untrusted" contributors? Yes, run https://codeberg.org/Codeberg-Infrastructure/forgejo/ and in the `app.ini` have: https://codeberg.org/Codeberg-Infrastructure/build-deploy-forgejo/src/commit/fdfb6a47b5faf6255997cbfc0f207205ba488205/etc/forgejo/conf/base.ini#L12 FWIW, we also could like grant someone motivated access to https://codeberg.org/knut and simply use codeberg.org to make screenshots.
Sign in to join this conversation.
No milestone
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
Codeberg/Documentation#800
No description provided.