Codeberg/Documentation
42
199
Fork
You've already forked Documentation
161

Codeberg Documentation - Contributing screenshots #800

Open
opened 2026年06月03日 19:24:59 +02:00 by jarrodlovas · 1 comment
Contributor
Copy link

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
Copy link

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.
Sign in to join this conversation.
No Branch/Tag specified
main
renovate/mstruebing-editorconfig-checker-3.x
renovate/lycheeverse-lychee-0.x
renovate/markdownlint-cli2-0.x
renovate/markdown-it-14.x
renovate/davidanson-markdownlint-cli2-0.x
renovate/node-lts-slim
renovate/npm-pnpm-vulnerability
ci_pr_close_no_preview
pr-554
pr/554
gitea-icons-shortcode
No results found.
Labels
Clear labels
Codeberg Pages
Issues affecting Codeberg Pages
Documentation Usability
Issues related to using and reading docs.codeberg.org
Forgejo
Good First Issue! 👋
Kind: Bug
Kind: Documentation
Kind: Enhancement
Kind: Feature
Kind: Question
Kind: Security
Licensing
Part: Generator
This is related to the generation of the documentation, not to the content itself
Priority: High
The priority is high
Priority: Low
The priority is low
Priority: Medium
The priority is medium
Reviewed: Confirmed
Something has been confirmed
Reviewed: Duplicate
Something exists already
Reviewed: Invalid
Something was marked as invalid
Reviewed: Wontfix
Something won't be fixed
Status: Blocked
Status: Help wanted
Contributions are welcome!
Status: In progress
Work is in progress
Status: Needs feedback
Feedback is needed
Status: Ready for Review
Work is completed
Status: Review
Review is in progress / Reviewers wanted
Status: Stale
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 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
Reference in a new issue
Codeberg/Documentation
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?