Press / to focus
Codeberg Documentation

Getting Started with Codeberg
What is Codeberg? Your First Steps on Codeberg Install Git Your First Repository The Basics of Issue Tracking Integrated Wiki Email Settings Licensing on Codeberg Frequently Asked Questions
Collaborating with Others
Citable Code Pull requests and Git flow Invite Collaborators Create and Manage an Organization Repository Permissions Resolve Conflicts
Working with Git Repositories
Using .gitignore Configuring Git Clone & Commit via CLI Clone & Commit via Web Merge multiple commits into one Tags and Releases Working with large files
Writing in Markdown
Introduction to Markdown Using Links Topics Preformatted Text Using Images Using Lists Tables in Markdown Markdown FAQ
Security
Setting up two-factor authentication Adding an SSH key to your account Verifying you're connected to Codeberg using SSH fingerprints Adding a GPG key to your account
Codeberg Pages
Using Custom Domains Troubleshooting Example: Docs as Code with Sphinx Pushing output from SSGs into Codeberg Pages Redirects
Advanced Usage
Using Webhooks Generating an Access Token Migrating Repositories
Working with Codeberg's CI
Using Forgejo Actions (Self-hosted)
Integrations with Other Services
Integrating with Keycloak Integrating with Matrix Integrating with Read the Docs
Codeberg Translate
Getting started Manual Component configuration Introduction to Weblate
Improving Codeberg
Contributing Code
Improving the Documentation
Style Guide How to create a new article? Can I preview my article? How to make screenshots for Codeberg Documentation? Documentation Contributor FAQ
Contact

Getting started

This article will guide you, how to integrate Weblate with Codeberg.

Projects and Components

The first thing you might notice, is that Weblate has Projects and Components. A Component is something that can be translated e.g. a Software or a Documentation. A Project is a Collection of Components that belong to the same thing. e.g. You have a Software and the corresponding Documentation. Both use different translation systems. So you add a Project for your Software and one Component for the Software itself and another one for the Documentation. In simple cases you only need one Component in a Project.

Create a new Project

On Codeberg Translate log in with your Codeberg Account. Now click on "+" and select "Add new translation project". Now just enter some Metadata such as the Name, the URL slug (This is just the URL you find your projects. You project will live under the URL https://translate.codeberg.org/projects/<your slug>), the Link to the Website (if you don't have one, just use the URL of your Codeberg Repo) and some instructions, how this Project should be translated (can be empty). This are just Metadata. They have no meaning, when you connect to your Codeberg Repo later. Click on "Save" and you are done.

Add a Component

You now see your new project with no components at all. Now let's add a Component.

  1. First click on the "Add new translation component" Button. You should see this Page.
Image the add component page
  1. Now enter the following:
  • Name: The Name of your Component. You can choose freely.
  • URL slug: The URL, you can find your Component (https://translate.codeberg.org/projects/<your project>/<your component slug>)
  • Source language: If the source language of your Project is not English, select it here.
  • Source code repository: The URL to your Codeberg Repo e.g. https://codeberg.org/Codeberg/Documentation. If you already have a component, that uses this Repo, use weblate://<project>/<component> to link it with the existing component instead.

Leave the rest as it is and click "Continue". Weblate will now scan your Repo and you should see something like this:

Image the add component page

Weblate have searched your Repo for common translation structures and presents you what was found. If you select one, Weblate will set some settings automatically. You can change them later or fully configure the component manually. Please note, that one Component only works with one translation system in one directory. If you have multiple, you need to add multiple components.

  1. On the following page, you should select "Gitea pull request" under "Version control system", so Weblate will create a new PR to submit changes to your Repo. If you haven't selected a Configuration from Weblate, visit Manual Component configuration. Now you should just select a Translation License and click "Save". Now you are done on the Weblate side.

  2. On the Codeberg side, open your Repo settings and go the Webhooks. Now click "Add Webhook" and select "Gitea" from the drop down. Under "Target URL" enter https://translate.codeberg.org/hooks/gitea and click "Add Webhook". Now Codeberg will notify Weblate about changes in your Repo, so it will be automatically updated.

Now you can share to the Link to Weblate to your translators.

Commit translations to Codeberg

To commit the translations from your Component to Codeberg, go to your Component>Manage>Repository Maintance and click on "Push"

Hey there! 👋 Thank you for reading this article!

Is there something missing, or do you have an idea on how to improve the documentation? Do you want to write your own article?

You're invited to contribute to the Codeberg Documentation at its source code repository, for example, by adding a pull request or joining in on the discussion in the issue tracker.

For an introduction on contributing to Codeberg Documentation, please have a look at the Contributor FAQ.

© Codeberg Docs Contributors. See LICENSE