diff --git a/content/improving-codeberg/contributing-code.md b/content/improving-codeberg/contributing-code.md index e0a91fe..53b4570 100644 --- a/content/improving-codeberg/contributing-code.md +++ b/content/improving-codeberg/contributing-code.md @@ -5,7 +5,7 @@ eleventyNavigation: parent: ImprovingCodeberg --- -Hey there, thank you for heading here and your interest in improving Codeberg. This page is intended to give you a quick start on how and where to contribute code to the platform of Codeberg itself. Some things are always changing and we're not (yet) good at continously updating the docs on that - but we're always glad to help you with your questions. Just reach out and ask! +Hey there, thank you for heading here and your interest in improving Codeberg. This page is intended to give you a quick start on how and where to contribute code to the platform of Codeberg itself. Some things are always changing, and we're not (yet) good at continuously updating the docs on that — but we're always glad to help you with your questions. Just reach out and ask! Since Codeberg uses [Gitea](https://gitea.io/) as a base, most features that go beyond configuration changes are required upstream and every helping hand is very welcome to improve Gitea and thus Codeberg. @@ -15,16 +15,16 @@ Gitea itself is written in [Go](https://en.wikipedia.org/wiki/Go_(programming_la We currently sort patches on the following criteria: - Changes in deployments and config goes to the [Codeberg/build-deploy-gitea](https://codeberg.org/Codeberg/build-deploy-gitea) repo. It holds the scripts used to set up the Codeberg instance and overrides other changes, so have a look at it in any case! -- Changes that benefit the general gitea userbase should go into the [upsteram repo](https://github.com/go-gitea/gitea). Contributions there also help improving Codeberg, so consider raising a merge request there to help all instances of Gitea -- A small set of patches is directly committed into the [Codeberg/gitea](https://codeberg.org/Codeberg/gitea) repo, these include +- Changes that benefit the general Gitea user base should go into the [upstream repo](https://github.com/go-gitea/gitea). Contributions there also help improve Codeberg, so consider raising a merge request there to help all instances of Gitea +- A small set of patches are committed directly into the [Codeberg/gitea](https://codeberg.org/Codeberg/gitea) repo, these include - (Non-configurable) template changes or small tweaks that are not intended for upstream - Hot-fixes for urgent issues (like anti-spam measures) that are sometimes low quality and thus not upstream, but would require a proper solution in the software itself - - Backports of gitea commits with important features or fixes that won't be officially backported - - Cherry-picked commits of pending upstream PRs we want to include sooner + - Backports of Gitea commits with important features or fixes that won't be officially backported + - Cherry-picked commits of pending upstream PRs we want to include sooner. ## Getting started -So let's put our hands-on and start hacking. If you don't already have an issue in mind you want to fix, have a look at the [Community issues](https://codeberg.org/Codeberg/Community/issues) and especially those that are labeled with "[contribution welcome](https://codeberg.org/Codeberg/Community/issues?q=&type=all&state=open&labels=105&milestone=0&assignee=0)", this indicates we would really appreciate your help there 🤗. If you didn't find something yet, go for the Gitea issue tracker. It's likely that you find something interesting amongst the thousands of open reports and feature requests there, espcially with the good first issues. +So let's put our hands-on and start hacking. If you don't already have an issue in mind you want to fix, have a look at the [Community issues](https://codeberg.org/Codeberg/Community/issues) and especially those that are labelled with "[contribution welcome](https://codeberg.org/Codeberg/Community/issues?q=&type=all&state=open&labels=105&milestone=0&assignee=0)", this indicates we would really appreciate your help there 🤗. If you didn't find something yet, go for the Gitea issue tracker. It's likely that you find something interesting amongst the thousands of open reports and feature requests there, especially with the good first issues. ### Working with the `build-deploy-gitea` repo @@ -32,7 +32,7 @@ The deployment of Codeberg is handled via the [Codeberg/build-deploy-gitea](http The deployment Makefile connects to a remote server via ssh, so we recommend configuring a virtual machine for this. You can use the provided script or perform the following tasks inside your favourite VM / container solution: - Add a user and group git - Provide SSH to root -- Setup a MySQL database `gitea` end enter the credentials into your app.ini +- Set up a MySQL database `gitea` end enter the credentials into your app.ini - Install at least git make nodejs npm openssh-server librsvg2-bin (example package names from Debian Buster) - Run the makefile and see that Gitea is installed, you can override variables and run it like `make HOSTNAME_FQDN=localhost deployment` - After Gitea is installed, you might want to create an admin user for testing (should otherwise be first user by default), you can use `sudo -u git GITEA_WORK_DIR=/data/git GITEA_CUSTOM/etc/gitea /data/git/bin/gitea admin create-user --username you --admin --password yourpassword --email youremail@example.com` @@ -63,7 +63,7 @@ If you fixed an issue specific to Codeberg that should not go into the upstream ### Working on better deployment methods -If you want to help us improving our deployment scripts, check out the [Codeberg-Infrastructure organization](https://codeberg.org/Codeberg-Infrastructure) (only visible when logged in) and check out eventual configuration. We'd really appreciate to move away from Makefile and shell scripts and ask you to join the discussion there. Please make sure to first understand what the `build-deploy-gitea` repo does to replicate it's function. Also feel free to contact us (for example via Matrix) to ask where to help. +If you want to help us improve our deployment scripts, check out the [Codeberg-Infrastructure organization](https://codeberg.org/Codeberg-Infrastructure) (only visible when logged in) and check out eventual configuration. We'd really appreciate moving away from Makefile and shell scripts and ask you to join the discussion there. Please make sure to first understand what the `build-deploy-gitea` repo does to replicate its function. Also feel free to contact us (for example via Matrix) to ask where to help. ## Still questions? diff --git a/content/improving-codeberg/docs-contributor-faq.md b/content/improving-codeberg/docs-contributor-faq.md index 95b7fed..1ae0992 100644 --- a/content/improving-codeberg/docs-contributor-faq.md +++ b/content/improving-codeberg/docs-contributor-faq.md @@ -84,21 +84,21 @@ They should be created using the "Knut" demo account on `codeberg-test.org`. If 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 +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). Please put screenshots under `assets/images/[section]/[article]/...` where `[section]` and `[article]` are the kebab-cased names of the section or your article, respectively. -Codeberg Documentation uses the webP format wherever possible, in order to increase page loading speed and reduce traffic due to its powerful compression. +Codeberg Documentation uses the WebP format wherever possible, in order to increase page loading speed and reduce traffic due to its powerful compression. -To convert a screenshot to webP, you can use the `cwebp` command line utility like this: +To convert a screenshot to WebP, you can use the `cwebp` command line utility like this: ```bash cwebp -lossless screenshot.png -o screenshot.webp ``` -If you prefer a GUI, there a [a number of options](https://en.wikipedia.org/wiki/WebP#Graphics_software) available, but please be sure that your GUI doesn't add thumbnails into the WebP file, which would inflate its size, rendering its key advantage meaningless. +If you prefer a GUI, there are [a number of options](https://en.wikipedia.org/wiki/WebP#Graphics_software) available, but please be sure that your GUI doesn't add thumbnails into the WebP file, which would inflate its size, rendering its key advantage meaningless. > At the time of writing, there is no support for webP images in Safari browsers. > As a workaround, all images (except SVG) in codeberg documentation are currently to be included using a `` tag, like so: