Refresh Contact, Getting Started, Contributing Pages (#394)
Update contact page Prefer references to Forgejo, more relevant to users Updates to Getting Started Pages / FAQ - a lot of content was outdated and generally rewritten or rephrased - implement procedure for size limits as determined by annual assembly 2023, see Codeberg-e.V./Discussion#92 - people are sometimes confused wheter you need to be a paying member in Codeberg e.V. in order to use the platform Update improving Codeberg guides - reduce redundancy in code contribution guide and reference the Contributing Issue Tracker instead - separate (and ideally more appealing) donation page (deserves even more love IMHO) - shorten and strip outdated information Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/394 Reviewed-by: Panagiotis "Ivory" Vasilopoulos <git@n0toose.net> Co-authored-by: Otto Richter <git@otto.splvs.net> Co-committed-by: Otto Richter <git@otto.splvs.net>
This commit is contained in:
Otto Richter
parent
2b85a21e70
commit
d5f6f22999
12 changed files with 223 additions and 158 deletions
|
|
@ -52,7 +52,7 @@ To migrate a repo with its metadata from a different service, you will first nee
|
|||
</picture>
|
||||
|
||||
Here's an explanation of some fields on the [Gitea migration page](https://codeberg.org/repo/migrate?service_type=3):
|
||||
- **Migrate / Clone From URL**: This is the URL to your repository. For example: `https://gitea.com/gitea/tea`.
|
||||
- **Migrate / Clone From URL**: This is the URL to your repository. For example: `https://code.forgejo.org/forgejo/end-to-end`.
|
||||
- **Access Token**: You will paste the access token generated here. An access token is required to migrate metadata or non-public repositories.
|
||||
- **Migration Items**: Here you can select the metadata you want migrated.
|
||||
- **Owner**: The new owner of the migrated repository.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
eleventyNavigation:
|
||||
key: UsingForgejoActions
|
||||
title: Using Forgejo / Gitea Actions (Self-hosted)
|
||||
title: Using Forgejo Actions (Self-hosted)
|
||||
parent: CI
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -46,12 +46,11 @@ please consult [Woodpecker's documentation](https://woodpecker-ci.org/docs/intro
|
|||
You can alternatively host your own Woodpecker instance and link it to Codeberg.
|
||||
This will give you a lot more freedom and capabilities with the downside of having to utilize your own hardware.
|
||||
Please consult Woodpecker's
|
||||
[Gitea integration documentation](https://woodpecker-ci.org/docs/administration/forges/gitea)
|
||||
[Forgejo integration documentation](https://woodpecker-ci.org/docs/administration/forges/gitea)
|
||||
for more information.
|
||||
(Codeberg is running Forgejo, a fork of Gitea)
|
||||
|
||||
## Using Codeberg / Forgejo / Gitea Actions
|
||||
## Using Forgejo Actions
|
||||
|
||||
Forgejo, the software Codeberg is built on, offers a CI/CD feature called Actions. It offers compatibility with GitHub Actions, [with some differences](https://docs.gitea.com/usage/actions/comparison).
|
||||
|
||||
Further information such as how to run it is available in [Using Forgejo / Gitea Actions (Self-hosted) page](./actions).
|
||||
Further information such as how to run it is available in [Using Forgejo Actions (Self-hosted) page](./actions).
|
||||
|
|
|
|||
|
|
@ -6,24 +6,47 @@ eleventyNavigation:
|
|||
order: 90
|
||||
---
|
||||
|
||||
## Stay up to date
|
||||
|
||||
We recommend to follow us on [Mastodon](https://social.anoxinon.de/@Codeberg).
|
||||
You can also [check out our blog](https://blog.codeberg.org).
|
||||
Also check out the Matrix Channels mentioned below!
|
||||
|
||||
|
||||
## Questions and Issues
|
||||
The most important place to ask for help and report any issues with Codeberg is the [Codeberg/Community issue tracker](https://codeberg.org/Codeberg/Community/issues). It's never wrong to open a ticket there.
|
||||
|
||||
If you need quicker help or want to freely discuss topics, or follow up on Codeberg news, you can
|
||||
Codeberg relies on community support and helping each other.
|
||||
You should try asking a question in public first.
|
||||
There are most likely people around to help you out,
|
||||
and your question will help users who experience similar problems in the future.
|
||||
|
||||
The most important place to ask for help and report any issues with Codeberg is the [Codeberg/Community issue tracker](https://codeberg.org/Codeberg/Community/issues).
|
||||
It's **never** wrong to open a ticket there.
|
||||
|
||||
If you need help quickly, or just want to join our community for exchange, discussions and news, you should consider to:
|
||||
|
||||
- join the community on [Matrix](https://matrix.to/#/#codeberg-space:matrix.org)! General discussions take place in the [Codeberg room](https://matrix.to/#/#codeberg.org:matrix.org).
|
||||
- follow us on [Mastodon](https://social.anoxinon.de/@Codeberg), or if you aren't on the free and federated social network yet, [on Twitter](https://twitter.com/codeberg_org). You can also send us a direct message (Mastodon / Fediverse will have quicker response times, though).
|
||||
- join the unofficial (community-created) `#codeberg` IRC channel at [libera.chat](https://libera.chat)
|
||||
- join the unofficial (community-maintained) `#codeberg` IRC channel on [libera.chat](https://libera.chat) (much less activity than on Matrix)
|
||||
|
||||
## Email
|
||||
Please only drop us an email if your problem cannot be handled via the channels above.
|
||||
You can send an email to [help@codeberg.org](mailto:help-PLEASE-REMOVE-THIS-FOR-SPAM-PROTECTION@codeberg.org).
|
||||
**Attention:** There is currently no team regularly reading emails,
|
||||
we are still looking for help, see [Codeberg/Contributing#28](https://codeberg.org/Codeberg/Contributing/issues/28).
|
||||
|
||||
If you need to get in touch with the people behind the **non-profit Codeberg e.V. (e.g. for managing your membership etc)**, please instead write to [codeberg@codeberg.org](mailto:codeberg-PLEASE-REMOVE-THIS-FOR-SPAM-PROTECTION@codeberg.org).
|
||||
### Email
|
||||
|
||||
If you need to get in touch with the people behind the **non-profit Codeberg e.V.
|
||||
(e.g. for managing your membership etc)**, and only in this case,
|
||||
write to [codeberg@codeberg.org](mailto:codeberg-PLEASE-REMOVE-THIS-FOR-SPAM-PROTECTION@codeberg.org).
|
||||
|
||||
Please only send us an email if your problem cannot be handled via public community support.
|
||||
Our user support is maintained by very few people in their spare time,
|
||||
and [reading the FAQ](/getting-started/faq) first is always a good idea!
|
||||
If you believe that users should get kind responses to their emails,
|
||||
[consider helping us out.](https://codeberg.org/Codeberg/Contributing/issues/28)!
|
||||
|
||||
If you still need to contact us, please email
|
||||
[help@codeberg.org](mailto:help-PLEASE-REMOVE-THIS-FOR-SPAM-PROTECTION@codeberg.org).
|
||||
**Response times will be very long. If you do not receive a reply,**
|
||||
double-check if your question can be found in the [FAQ](/getting-started/faq)
|
||||
or asked via the public channels above.
|
||||
|
||||
### Legal inquiries
|
||||
For legal inquiries, please refer to the [Imprint](https://codeberg.org/codeberg/org/src/Imprint.md).
|
||||
|
||||
### Abuse
|
||||
|
||||
|
|
@ -42,8 +65,13 @@ Please keep in mind that we are only responsible for content hosted under the fo
|
|||
- `codeberg.page` (including custom domains using *Codeberg Pages*)
|
||||
- `codeberg-test.org`
|
||||
- `codeberg.eu`
|
||||
- `next.forgejo.org`
|
||||
|
||||
After submitting your report, please do not expect a written response. All
|
||||
reports will be investigated and acted upon accordingly, but we do not
|
||||
typically inform users who submitted each report about the results.
|
||||
reports will be investigated and acted upon accordingly,
|
||||
but due to constrained human resources and the possibility of duplicated reports,
|
||||
we do not typically find the time to keep you updated about the status of your reports.
|
||||
|
||||
|
||||
### Legal inquiries
|
||||
|
||||
For legal inquiries, please refer to the [Imprint](https://codeberg.org/codeberg/org/src/Imprint.md).
|
||||
|
|
|
|||
|
|
@ -8,28 +8,50 @@ eleventyNavigation:
|
|||
|
||||
## Codeberg's Structures
|
||||
|
||||
### What do I need to use Codeberg?
|
||||
|
||||
All you need to use Codeberg is your user account on Codeberg.org.
|
||||
It is both free-as-in-beer and free-as-in-freedom,
|
||||
as long as you follow our [Terms Of Use](https://codeberg.org/codeberg/org/src/TermsOfUse.md).
|
||||
|
||||
A membership in the backing non-profit association Codeberg e.V. is completely optional.
|
||||
We still invite you to become part of our mission by joining it.
|
||||
Your membership fee helps to improve the project,
|
||||
and the distributed voting rights maintain a healthy governance of the project.
|
||||
|
||||
|
||||
### Is Codeberg well funded?
|
||||
Codeberg is primarily funded by [donations](/improving-codeberg/#donate-to-codeberg). As of July 2020, with all expenses frozen, we have a runway of ~12 years, so you don't have to worry that our service will suddenly disappear.
|
||||
Still, we can always make good use of donations! They allow us not only to operate the minimum services,
|
||||
|
||||
Don't worry, the danger of having Codeberg disappear are low!
|
||||
|
||||
Codeberg is powered by donations and membership fees of the non-profit association.
|
||||
The non-profit Codeberg e.V. members decide over the budget plans once a year,
|
||||
and they take care to put some funds aside to allow for a certain runway even under exceptional circumstances.
|
||||
|
||||
However, if you compare Codeberg to platforms which charge a fee for every user,
|
||||
Codeberg has significantly less funding.
|
||||
We kindly ask you to consider setting up a recurring donation.
|
||||
|
||||
We can always make good use of donations. They allow us not only to operate the minimum services,
|
||||
but extend the features, add new services, and generously offer more power e.g. for CI and Code Search.
|
||||
|
||||
## Where is Codeberg hosted?
|
||||
We are hosted on our own hardware in a rented facility in Berlin, Germany.
|
||||
We might additionally offload certain tasks to other providers,
|
||||
e.g. [netcup GmbH](https://www.netcup.de/) and [Hetzner Online GmbH](https://www.hetzner.com/),
|
||||
e.g. for backups / redundancy etc.
|
||||
### Where is Codeberg hosted?
|
||||
|
||||
Most of our services run on own hardware in a rented facility in Berlin, Germany.
|
||||
The networking and rackspace is provided by another volunteer-driven association.
|
||||
|
||||
Certain tasks are offloaded to other locations and providers,
|
||||
e.g. [netcup GmbH](https://www.netcup.de/) and [Hetzner Online GmbH](https://www.hetzner.com/).
|
||||
This is for backups, redundancy, disaster recovery, DDoS protection,
|
||||
efficiency (using spare resources provided to us) and various other reasons.
|
||||
We make sure that your data is sufficiently protected and avoid large cloud providers where possible.
|
||||
|
||||
### Is Codeberg based on free and open-source software?
|
||||
### Is Codeberg based on free/libre (and open-source) software?
|
||||
In short, **yes** — And proudly so! Codeberg uses [Forgejo](https://forgejo.org)
|
||||
for its primary offering. Forgejo is a soft fork of [Gitea](https://gitea.com)
|
||||
that specifically focuses on open-source development. It is not a Codeberg
|
||||
project per se, but the two projects work together closely:
|
||||
The non-profit association that is backing Codeberg (*Codeberg e.V.*) acts as a
|
||||
fiscal sponsor to Forgejo and there is a significant overlap between the contributors
|
||||
of both projects.
|
||||
which explicitly uses free software for development.
|
||||
And you can easily host it yourself!
|
||||
|
||||
Some other examples of open-source works that we use are:
|
||||
Some other examples of free software works that we use are:
|
||||
- [Woodpecker CI](https://woodpecker-ci.org). It powers [Codeberg CI](/ci).
|
||||
- [Weblate](https://weblate.org). It is what we use for [Codeberg Translate](https://translate.codeberg.org).
|
||||
- [Codeberg Pages](https://codeberg.page). This is a "homebrewed" piece of
|
||||
|
|
@ -38,6 +60,7 @@ Some other examples of open-source works that we use are:
|
|||
which is used internally by our non-profit association to carry out votes among members.
|
||||
- [Even the text you are reading right now](https://codeberg.org/Codeberg/Documentation/src/branch/main/content/getting-started/faq.md)
|
||||
is [licensed under a Creative Commons license](https://codeberg.org/Codeberg/Documentation/src/branch/main/LICENSE.md)!
|
||||
- [Configuration and helper tools of Codeberg](https://codeberg.org/Codeberg-Infrastructure/) are also freely available for you to study, improve and reuse.
|
||||
|
||||
We use the [Codeberg organization](https://codeberg.org/Codeberg) (as well as other
|
||||
organizations that are linked in its description) to share what we have worked on.
|
||||
|
|
@ -51,29 +74,36 @@ For more details see [Licensing article](/getting-started/licensing).
|
|||
However, we sometimes tolerate repositories that aren't perfectly licensed and focus on spreading awareness on the topic of improper FLOSS licensing and its issues.
|
||||
|
||||
### Can I use private repositories for my project?
|
||||
It depends. Our [Terms of Service](https://codeberg.org/codeberg/org/src/TermsOfUse.md#2-allowed-content-usage) stipulates a couple of exceptions that should cover most use cases:
|
||||
|
||||
> Reasonable exceptions are to a very limited extent considered acceptable. For example, releasing single logo image files of a FLOSS project under no licence or a separate non-free licence that requires derivative works to use their own logo that is clearly distinguishable from the original work even in absence of trademark registration. Private repositories are only allowed for things required for FLOSS projects, like storing secrets, team-internal discussions or hiding projects from the public until they're ready for usage and/or contribution.
|
||||
In many cases, yes, but please read on.
|
||||
Our goal is to support Free Content, and we do not act as a private hosting for everyone!
|
||||
However, if we see that you contribute to Free Software / Content and the ecosystem,
|
||||
we allow **up to 100 MB of private content** for your convenience.
|
||||
Further exceptions are spelled out in our [Terms of Service](https://codeberg.org/codeberg/org/src/TermsOfUse.md#2-allowed-content-usage):
|
||||
|
||||
Codeberg is intended for free and open source content, and we may impose stricter limitations in the future.
|
||||
If you are not sure whether your use case is acceptable,
|
||||
[you should make a formal request to an administrator](https://codeberg.org/Codeberg-e.V./requests).
|
||||
> Private repositories are only allowed for things required for FLOSS projects, like storing secrets, team-internal discussions or hiding projects from the public until they're ready for usage and/or contribution.
|
||||
|
||||
### Can I host personal, private repositories that I do not intend to publish?
|
||||
In most cases. Our [Terms of Service](https://codeberg.org/codeberg/org/src/TermsOfUse.md#2-allowed-content-usage) also mention:
|
||||
If you are still not sure if your usage is allowed or if you require a lot of private space for a Free Software project,
|
||||
[please send us a formal request](https://codeberg.org/Codeberg-e.V./requests) and we'll have a look.
|
||||
|
||||
> [Private repositories] are also allowed for really small & personal stuff like your journal, config files, ideas or notes, but explicitly not as a personal cloud or media storage.
|
||||
|
||||
If there is a good reason why you need to use a lot of space for a personal repository,
|
||||
you [should make a formal request to an administrator](https://codeberg.org/Codeberg-e.V./requests)
|
||||
so that we can give you an explicit permission to do so.
|
||||
### What is the size limit for my repositories? Are there quotas for packages, LFS, ...?
|
||||
|
||||
### What is the size limit for my repositories?
|
||||
We do not have a fixed limit, as long as your use case
|
||||
is not impacting the quality of our services for other users and projects.
|
||||
Codeberg strives to provide **everyone with the necessary resources** to develop high quality Free/Libre software.
|
||||
There is no intention of monetizing you based on limits and quotas!
|
||||
So there **is no quota for valid use-cases**!
|
||||
|
||||
However, we will review larger projects and reserve the right to deny service if we consider your resource usage unreasonable,
|
||||
or if your usage impacts the quality and stability for other users.
|
||||
|
||||
If you intend to use more than:
|
||||
|
||||
- 750 MiB for Git storage
|
||||
- 1.5 GiB of packages, LFS and attachments
|
||||
- generally large CI resources
|
||||
|
||||
You should [request these resources first](https://codeberg.org/Codeberg-e.V./requests)!
|
||||
|
||||
For more information, please refer to our
|
||||
[Terms of Service](https://codeberg.org/codeberg/org/src/TermsOfUse.md#repositories-wikis-and-issue-trackers).
|
||||
|
||||
## I need to request more resources from an administrator. How do I do that?
|
||||
We have a public repository, [Codeberg-e.V./requests](https://codeberg.org/Codeberg-e.V./requests),
|
||||
|
|
|
|||
|
|
@ -34,20 +34,25 @@ Dependencies on commercial, external, or proprietary services for the operation
|
|||
|
||||
Read more at [Codeberg's initial announcement](https://blog.codeberg.org/codebergorg-launched.html) and the [Licensing article](/getting-started/licensing).
|
||||
|
||||
## Codeberg vs. Forgejo/Gitea
|
||||
## Codeberg vs. Forgejo
|
||||
|
||||
[Forgejo](https://forgejo.org) is self-hostable free software for software development, built on top of Git. Codeberg is powered by Forgejo, which is in turn a soft-fork of Gitea. Compared to Codeberg, Forgejo is not one service, but free software to help you build your own. Everyone can install their own Forgejo instance to host their own projects. There are also public Forgejo instances as well as Codeberg you can use, but make sure you find a site that is actively maintained and updated, and that you trust the provider.
|
||||
|
||||
The codebase history of Forgejo and its predecessors predates Codeberg.
|
||||
However, since 2022, [Codeberg is backing the development of Forgejo](https://blog.codeberg.org/codeberg-launches-forgejo.html) as an umbrella organization.
|
||||
|
||||
People are often asking why they should use Codeberg over other Forgejo instances. The most important reasons are:
|
||||
- a vivid, vibrant community to collaborate with and ask for help
|
||||
- active maintenance through the community and shared effort to provide an awesome experience
|
||||
- you are able to take part in operation and decisions, and ideally donate
|
||||
- we add additional services like [Codeberg Pages](/codeberg-pages/) and in the future hosted CI
|
||||
- we add additional services like [Codeberg Pages](/codeberg-pages/),
|
||||
[hosted CI](/ci/#using-codeberg's-instance-of-woodpecker-ci)
|
||||
and [Weblate for localization of your software](/codeberg-translate/)
|
||||
|
||||
## What is Codeberg e.V.?
|
||||
|
||||
Codeberg e.V. is a registered non-profit association based in Berlin, Germany. You don't have to be
|
||||
a member of the association in order to join Codeberg.org or to contribute to the development
|
||||
a member of the association in order to use Codeberg.org or to contribute to the development
|
||||
of the platform, but if you want you can [join Codeberg e.V.](https://join.codeberg.org) to
|
||||
support the project financially, be informed about Codeberg and, optionally, to actively
|
||||
contribute to the association.
|
||||
|
|
@ -66,10 +71,12 @@ By choosing a Forgejo instance, you can easily migrate away from Codeberg in cas
|
|||
|
||||
We'll list a few options:
|
||||
|
||||
- [disroot](https://git.disroot.org): Public Forgejo instance (next to other services) powered by community at disroot. Funded by donations.
|
||||
- [disroot](https://git.disroot.org): Our recommended alternative public Forgejo instance.
|
||||
Powered by the community at disroot and funded by donations.
|
||||
They do offer much more than Forgejo, so check them out in any case.
|
||||
- [other public Forgejo instances](https://codeberg.org/forgejo-contrib/delightful-forgejo#user-content-public-instances)
|
||||
- Self-Hosting [Forgejo](https://forgejo.org), the software that powers Codeberg.
|
||||
- [SourceHut](https://sourcehut.org): A minimum-GUI Free Software based service, available as hosted version by a transparent for-profit. Self-Hostable.
|
||||
- Self-Hosting [GitLab Community Edition](https://gitlab.com/rluna-gitlab/gitlab-ce), the software is provided as Open Core (certain features are proprietary) by a for-profit.
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,6 @@ Codeberg's Documentation mostly includes tutorials specific to using the platfor
|
|||
If what you are trying to do is not covered by our Documentation, the following resources can be helpful:
|
||||
|
||||
- [Forgejo User Guide](https://forgejo.org/docs/latest/user/)
|
||||
- [Gitea Usage Guide](https://docs.gitea.com/category/usage)
|
||||
- [Woodpecker CI Documentation](https://woodpecker-ci.org/docs/intro)
|
||||
- [Weblate Documentation](https://docs.weblate.org/en/latest/index.html)
|
||||
|
||||
|
|
|
|||
|
|
@ -5,29 +5,35 @@ 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 continuously 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.
|
||||
The various projects move at their own pace,
|
||||
so if you already know where you are going to contribute to,
|
||||
check out their own contributing guides or get in touch with the maintainers.
|
||||
|
||||
Since Codeberg uses [Forgejo](https://forgejo.org/) as a base, which itself is a soft-fork of [Gitea](https://gitea.io/). Most features that go beyond [configuration changes](https://docs.gitea.com/next/administration/config-cheat-sheet) and branding (e.g. the `codeberg-light` and `codeberg-dark` themes) should be addressed upstream; all contributions to both Forgejo and Gitea essentially help Codeberg by proxy and are immensely appreciated.
|
||||
The following projects always need a helping hand:
|
||||
|
||||
- [Forgejo](https://forgejo.org/), the software that powers Codeberg.org and all the Git features
|
||||
- [Weblate](https://weblate.org), the localization platform available at [translate.codeberg.org](https://translate.codeberg.org)
|
||||
- [Woodpecker CI](https://woodpecker-ci.org), our hosted CI/CD solution.
|
||||
- [Codeberg Pages](https://codeberg.org/Codeberg/pages-server/), a service that allows you to serve static websites from Git repositories, see [codeberg.page](https://codeberg.page)
|
||||
|
||||
Also check out the [Codeberg](https://codeberg.org/Codeberg) and [Codeberg-Infrastructure](https://codeberg.org/Codeberg-Infrastructure) organizations, they contain numerous other software and setup projects that will appreciate your contributions.
|
||||
|
||||
## Working on Codeberg Projects
|
||||
|
||||
Running Codeberg means running lots of projects. Later sections of this tutorial will focus on Forgejo, which is one of the most crucial and arguably complex project of Codeberg.
|
||||
## Getting Started
|
||||
|
||||
A complete list with all of our projects, as well as their respective maintainers and chatrooms, can be found in [our Contributing repository](https://codeberg.org/Codeberg/Contributing).
|
||||
Having a lot of options to choose from is hard.
|
||||
We maintain a place for [all contributions to Codeberg](https://codeberg.org/Codeberg/Contributing) and you should read there.
|
||||
If you don't know where to start, go ahead and introduce yourself there.
|
||||
We'll try to match you with relevant and interesting tasks.
|
||||
|
||||
## Working with Forgejo
|
||||
|
||||
Forgejo itself is written in [Go](https://en.wikipedia.org/wiki/Go_(programming_language)). Don't let that intimidate you! Some contributors have made changes to Forgejo and Gitea without having programmed anything in the language beforehand; Go is focused on being a very easy and maintainable language, so you should not get intimidated by it (especially if you have experience with *Python* or a variant of *C* already).
|
||||
|
||||
### Finding issues to work on
|
||||
## Finding issues to work on
|
||||
|
||||
The following issue trackers may contain a few ideas for things that could be worked on:
|
||||
|
||||
- [Codeberg Community Tracker](https://codeberg.org/Codeberg/Community/issues?&state=open&labels=338)
|
||||
- [Forgejo Issue Tracker](https://codeberg.org/forgejo/forgejo/issues)
|
||||
- [Gitea Issue Tracker](github.com/go-gitea/gitea/issues)
|
||||
|
||||
We also recommend working on changes that *personally* bother you first. Something in the direction of simple UI changes changes would probably make the most sense, as they are the easiest to get started with and will help you get more acquainted with the codebase (which could help you solve more complicated problems later) in the process.
|
||||
|
||||
|
|
@ -35,69 +41,6 @@ Solving easy problems helps a lot too! It makes Codeberg's underlying software l
|
|||
|
||||
In the *Codeberg Community Tracker*, there are some issues that are marked using the [`contribution welcome`](https://codeberg.org/Codeberg/Community/issues?&state=open&labels=105) tag. This tag is meant to show that we would really appreciate your help here. They also act as a good starting point if you are looking for something to work on.
|
||||
|
||||
### Where should I send my patch?
|
||||
|
||||
Codeberg has two repositories related to Forgejo:
|
||||
- [Codeberg-Infrastructure/build-deploy-forgejo](https://codeberg.org/Codeberg-Infrastructure/build-deploy-forgejo): Contains scripts that are used to set up our Codeberg instance
|
||||
- [Codeberg/forgejo](https://codeberg.org/Codeberg/forgejo): Forgejo fork that contains branding changes (e.g. themes), hot-fixes for urgent issues (like "dirty" anti-spam measures) and unofficial backports with features or fixes that we find important.
|
||||
|
||||
If you have a problem with how Codeberg looks like or if you would like to change something to Codeberg's documentation, you would probably have to submit your change to one of these two repositories.
|
||||
|
||||
Alternatively, you should probably send in your patches to [Forgejo](https://codeberg.org/forgejo/forgejo) or [Gitea](https://github.com/go-gitea/gitea).
|
||||
|
||||
We would recommend sending your patches to *Forgejo*, as it is a project that is heavily associated and works together with Codeberg. Any changes made to Forgejo will land to Codeberg
|
||||
and will also benefit other Forgejo users.
|
||||
|
||||
### Working with the Forgejo codebase
|
||||
|
||||
In order to start working with the Forgejo repository, we would recommend checking out [the Forgejo docs](https://forgejo.org/docs/latest/developer/) and [the Gitea docs](https://docs.gitea.com/development/hacking-on-gitea) first.
|
||||
|
||||
They provide more detailed and especially more up-to-date information than we could maintain in our own docs. Additionally, there's probably no need for redundancy here 😉.
|
||||
|
||||
If you get stuck at any point, Forgejo provides [chatrooms](https://matrix.to/#/#forgejo:matrix.org) that have people that would be willing to help you.
|
||||
|
||||
### Working with the `build-deploy-forgejo` repo
|
||||
|
||||
This is the deployment system for the Codeberg infrastructure, it updates, builds, configures and deploys Forgejo.
|
||||
If you want to work on new features, please don't use it, but choose our [Forgejo fork](https://codeberg.org/Codeberg/forgejo) instead. You shouldn't normally need to bother running `build-deploy-forgejo`.
|
||||
|
||||
The deployment of Codeberg is handled via the [Codeberg/build-deploy-forgejo](https://codeberg.org/Codeberg/build-deploy-forgejo) repository. While there's some work on different deployment approaches (more to that later), this is the way stuff is handled as of today.
|
||||
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
|
||||
- Set up a MySQL database `forgejo` 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 Forgejo is installed, you can override variables and run it like `make HOSTNAME_FQDN=localhost deployment`
|
||||
- After Forgejo 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/forgejo admin create-user --username you --admin --password yourpassword --email youremail@example.com`
|
||||
Please see the deployment repo for the folder structure as well as the [upstream docs](https://forgejo.org/docs/) on how to configure and hack on Forgejo.
|
||||
|
||||
Also note that the Makefile will compile Codeberg's Forgejo fork from the `codeberg-test` branch by default. You can override this behaviour by specifying `ORIGIN` and `GITEA_BRANCH` environment to the Makefile.
|
||||
|
||||
### Working on better deployment methods
|
||||
|
||||
If you want to help us improve our deployment scripts, check out the [Codeberg-Infrastructure organization](https://codeberg.org/Codeberg-Infrastructure). We'd really appreciate moving away from Makefile and shell scripts and ask you to join the discussion there.
|
||||
If you are interested in supporting this project, feel free to contact us. Some legacy resources or WIP might be still invisible to normal users (although we always try to work publicly when possible).
|
||||
Please make sure to first understand what the `build-deploy-forgejo` repo does to replicate its function. Also feel free to contact us (for example via Matrix) to ask where to help.
|
||||
|
||||
### Raising an MR to our Forgejo fork
|
||||
|
||||
If you fixed an issue specific to Codeberg that should not go into the upstream repo or was refused there, but fits the criteria for our own repo written above, you can file an MR to [our own fork of Forgejo](https://codeberg.org/Codeberg/forgejo). Make sure to point your MR to the `codeberg` branch and rebase to the latest commits there. Also explain why this should go into the Codeberg repo, if not obvious.
|
||||
|
||||
{% admonition "warning" %}
|
||||
|
||||
Please note, that the branches may be force-pushed at
|
||||
certain times to make sure the Codeberg commits are well visible and
|
||||
maintainable at any time. This may lead to confusing behaviour of the
|
||||
merge requests, i.e. they seem to include commits you haven't made.
|
||||
|
||||
If you face this issue, you can `git rebase` your commits onto the
|
||||
current Codeberg branch and force-push.
|
||||
```shell
|
||||
git rebase origin/codeberg
|
||||
git push -f
|
||||
```
|
||||
|
||||
{% endadmonition %}
|
||||
|
||||
## More questions?
|
||||
|
||||
|
|
|
|||
70
content/improving-codeberg/donate.md
Normal file
70
content/improving-codeberg/donate.md
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
---
|
||||
eleventyNavigation:
|
||||
key: Donate
|
||||
title: Donating to Codeberg
|
||||
parent: ImprovingCodeberg
|
||||
---
|
||||
|
||||
Your generous donation helps Codeberg to run the servers,
|
||||
store thousands of awesome Free Software projects,
|
||||
develop new features and sustain the Free Software ecosystem around.
|
||||
|
||||
## How to Donate
|
||||
|
||||
<div class="card">
|
||||
<div class="card-body">
|
||||
<h5 class="card-title">Liberapay</h5>
|
||||
<p class="card-text">
|
||||
Set up your recurring donation to Codeberg via Liberapay.
|
||||
Allows payment via Stripe (Credit or Debit Card, Direct Debit and more) and PayPal.
|
||||
Liberapay itself is Free Software, but the payment processors are not.
|
||||
<br>
|
||||
<a href="https://liberapay.com/codeberg/donate" class="btn btn-primary">Donate using Liberapay</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-body">
|
||||
<h5 class="card-title">SEPA wire transfer</h5>
|
||||
<p class="card-text">
|
||||
Send us your donation directly to our bank account.
|
||||
An easy option for people with compatible bank accounts,
|
||||
and we have heard of others successfully using providers like Wise to transfer the money.
|
||||
<pre>
|
||||
Codeberg e.V.
|
||||
IBAN: DE90 8306 5408 0004 1042 42
|
||||
BIC: GENODEF1SLR
|
||||
</pre>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="card">
|
||||
<div class="card-body">
|
||||
<h5 class="card-title">Becoming a member of Codeberg e.V.</h5>
|
||||
<p class="card-text">
|
||||
If you join our non-profit association,
|
||||
your membership fee also helps keep Codeberg up and running.
|
||||
You can also receive voting rights and even join with your organization.
|
||||
<br>
|
||||
<a href="https://join.codeberg.org" class="btn btn-primary">Become a member!</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
### Receipts for donations / membership fees
|
||||
|
||||
Codeberg is based in Berlin, Germany and
|
||||
[recognized as tax-exempt](https://codeberg.org/codeberg/org/src/Imprint.md#user-content-gemeinn%C3%BCtzigkeit-recognition-of-status-as-non-profit-ngo-recognition-as-tax-excempt-entity) by the German authorities.
|
||||
|
||||
If you want to receive a receipt for your membership fee,
|
||||
please write us to [codeberg-at-codeberg.org](mailto:codeberg-PLEASE-REMOVE-THIS-PART-FOR-SPAM-PROTECTION@codeberg.org).
|
||||
|
||||
If you want to receive a receipt for your donation,
|
||||
please write to us using the address above,
|
||||
but additionally provide us with your full name and address, as well as with the date of your donation.
|
||||
|
||||
{% admonition "warning" %}
|
||||
Please beware that it might not always be possible to match your donation via PayPal and Stripe.
|
||||
We recommend donating via SEPA transfer if you want to be safe.
|
||||
{% endadmonition %}
|
||||
|
|
@ -12,7 +12,7 @@ Every helping hand, every contribution and every donation is warmly welcome.
|
|||
|
||||
You can support Codeberg in various ways:
|
||||
|
||||
### Use Codeberg
|
||||
## Use Codeberg
|
||||
|
||||
We're happy about every free software project actively using Codeberg,
|
||||
because we believe that every free project deserves a free home.
|
||||
|
|
@ -24,41 +24,29 @@ By joining and using Codeberg, you're already helping our mission a lot - thank
|
|||
|
||||
And as always: Spread the word, tell your friends and invite them to collaborate on Codeberg with you :-)
|
||||
|
||||
### Donate to Codeberg
|
||||
## Donate to Codeberg
|
||||
|
||||
You can [donate to Codeberg e.V. using Liberapay](https://liberapay.com/codeberg/donate)
|
||||
or [by SEPA wire transfer](https://codeberg.org/codeberg/org/src/Imprint.md#user-content-sepa-iban-for-donations).
|
||||
This section has moved to a dedicated page. <a href="./donate" class="btn btn-primary">Check out your options!</a>
|
||||
|
||||
Donations not only allow us to operate and scale the infrastructure behind Codeberg, but to develop the products that make Codeberg possible.
|
||||
Codeberg is not an arbitrary Forgejo instance, but commits itself into actively developing the software ecosystem around.
|
||||
|
||||
Codeberg e.V. is the non-profit organization behind Codeberg.org.
|
||||
|
||||
It's based in Berlin, Germany and [recognized as tax-exempt](https://codeberg.org/codeberg/org/src/Imprint.md#user-content-gemeinn%C3%BCtzigkeit-recognition-of-status-as-non-profit-ngo-recognition-as-tax-excempt-entity) by the German authorities.
|
||||
|
||||
### Join Codeberg e.V.
|
||||
## Join Codeberg e.V.
|
||||
|
||||
If you're interested in committing even more to Codeberg, consider [joining Codeberg e.V.](https://join.codeberg.org), the non-profit association behind Codeberg.org.
|
||||
|
||||
### Contribute to Codeberg
|
||||
## Contribute to Codeberg
|
||||
|
||||
Do you have ideas on improving Codeberg? Have you found a bug and would like to report (or even fix) it? You're welcome to contribute to Codeberg, for example by [creating or commenting on an Issue](https://codeberg.org/Codeberg/Community/issues) or by [writing a
|
||||
pull request](/collaborating/pull-requests-and-git-flow) to one of Codeberg's projects.
|
||||
Do you have ideas on improving Codeberg? Have you found a bug and would like to report (or even fix) it? You're welcome to contribute to Codeberg!
|
||||
|
||||
If you are not fond of doing codework, feel free to step up for some maintenance roles like Community Support, Social Media and more. Just drop us an email, or consider [Joining Codeberg](#join-codeberg-e.v.) where you'll get easier access to internal teams and task forces. Also, you can always [work on the Codeberg Docs](/improving-documentation/docs-contributor-faq).
|
||||
We coordinate teams and efforts using our [dedicated Contrib tracker](https://codeberg.org/Codeberg/Contributing).
|
||||
Head there to introduce yourself and find tasks that interest you.
|
||||
|
||||
You should also consider [Joining Codeberg](#join-codeberg-e.v.) where you'll get easier access to internal teams and task forces.
|
||||
Last but not least, you can always [work on the Codeberg Docs](/improving-documentation/docs-contributor-faq)!
|
||||
|
||||
Codeberg explicitly welcomes newcomers or career changers to its repos, and we will gladly mentor you as resources permit.
|
||||
If you have questions, always feel free to ask in the Issue Trackers or on the Matrix Channels mentioned on the [Contact page](/contact).
|
||||
Even tiny patches or suggestions, even if you are not a skilled developer, will be considered and are part of the community-maintenance mission of Codeberg.
|
||||
|
||||
You can read more about the code contribution workflow in [this article](contributing-code).
|
||||
|
||||
### Reporting issues
|
||||
## Reporting issues
|
||||
|
||||
If you experience an issue on some of the projects provided by Codeberg, please report it on Codeberg first so people can check if it's specific to Codeberg. See list of Codeberg projects below, with links to their repositories/issue trackers.
|
||||
|
||||
### Codeberg projects
|
||||
|
||||
An up-to-date list of projects that are maintained under the umbrella of
|
||||
Codeberg (or that are looking for maintainers 😉) is available
|
||||
at [https://codeberg.org/Codeberg/Contributing](https://codeberg.org/Codeberg/Contributing).
|
||||
|
|
|
|||
|
|
@ -8,7 +8,8 @@ eleventyNavigation:
|
|||
|
||||
These documentation pages contain information on how you can use third-party software with Codeberg.
|
||||
|
||||
See also [awesome-gitea](https://gitea.com/gitea/awesome-gitea/src/README.md) which lists projects that work with Gitea and Forgejo, the software which Codeberg is based on.
|
||||
Check out [delightful-forgejo](https://codeberg.org/forgejo-contrib/delightful-forgejo) to learn about the awesome ecosystem of Forgejo instances.
|
||||
Can can also see [awesome-gitea](https://gitea.com/gitea/awesome-gitea/src/README.md), most of the Gitea-specific solutions should work with our Forgejo instance, too.
|
||||
|
||||
{% assign navPages = collections.all | eleventyNavigation %}
|
||||
{%- for entry in navPages %}
|
||||
|
|
|
|||
|
|
@ -82,7 +82,7 @@ This is also _italic text_.
|
|||
Text may contain references to emoticons which are rendered as a small image, similar to an emoji.
|
||||
You can render these by typing the name of the emoticon you want to use, surrounded by colons (`:`), like this `:codeberg:`.
|
||||
|
||||
Some examples are `:codeberg:` which is rendered as <img src="https://codeberg.org/assets/img/emoji/codeberg.png" class="codeberg-design" style="border-style:none;width:1em;height:1em" alt="The Codeberg mountain" /> and `:gitea:` which is rendered as <img src="https://codeberg.org/assets/img/emoji/gitea.png" class="codeberg-design" style="border-style:none;height:1em;width=1em" alt="The Gitea tea cup" />.
|
||||
Some examples are `:codeberg:` which is rendered as <img src="https://codeberg.org/assets/img/emoji/codeberg.png" class="codeberg-design" style="border-style:none;width:1em;height:1em" alt="The Codeberg mountain" /> and `:forgejo:` which is rendered as <img src="https://codeberg.org/assets/img/emoji/forgejo.png" class="codeberg-design" style="border-style:none;height:1em;width=1em" alt="The forgejo f letter" />.
|
||||
|
||||
### Referencing issues and pull requests
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue