Skip to content

Commit e461a92

Browse files
BookWyrm Botgithub-actions[bot]
authored andcommitted
deploy versions
1 parent 7a22885 commit e461a92

File tree

197 files changed

+2675
-175
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

197 files changed

+2675
-175
lines changed

locale/de_DE/content/contributing/documentation.md

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,77 @@
11
---
2-
Title: Documentation
2+
Title: Dokumentation
33
Date: 2025-04-09
44
Order: 4
55
---
66

7-
The documentation you are reading right now is maintained by the BookWyrm community. Anyone can contribute to the docs.
7+
Die Dokumentation, die du gerade liest, wird von der BookWyrm-Community gepflegt. Jede Person kann zur Dokumentation beitragen.
88

9-
## Suggesting an improvement
9+
## Eine Verbesserung vorschlagen
1010

11-
You can report an **error**, suggest an **improvement** or request an **addition** to the documentation by [creating an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/creating-an-issue) in [the documentation repository](https://github.com/bookwyrm-social/documentation).
11+
Du kannst einen **Fehler** (engl. error) melden, eine **Verbesserung** (engl. improvement) vorschlagen oder eine **Ergänzung** (engl. addition) zur Dokumentation anfragen, indem du [einen Issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/creating-an-issue) im [Dokumentations-Repository](https://github.com/bookwyrm-social/documentation) anlegst.
1212

13-
## How the docs are made
13+
## Wie die Dokumentation erstellt wird
1414

15-
The Documentation [has its own GitHub repository](https://github.com/bookwyrm-social/documentation). Documentation is written in Markdown and we use [Jinja](https://jinja.palletsprojects.com/en/stable) and a Python script to convert that into HTML. A Jinja plugin is used with Crowdin to create translations. All documentation source files should be written in English (US).
15+
Die Dokumentation [hat ihr eigenes GitHub-Repository](https://github.com/bookwyrm-social/documentation). Sie wird in Markdown verfasst und wir nutzen [Jinja](https://jinja.palletsprojects.com/en/stable) und ein Python-Skript, um sie in HTML umzuwandeln. Ein Jinja-Plugin wird gemeinsam mit Crowdin genutzt, um Übersetzungen zu erstellen. Alle Quelldateien der Dokumentation sollen in US-Englisch verfasst werden.
1616

17-
All source files are saved in the `content` directory. Each section has a directory within that, with each page being represented by a single markdown file.
17+
Alle Quelldatein werden im `content`-Verzeichnis abgelegt. Jeder Abschnitt hat darin ein Verzeichnis, wobei jede Seite durch eine einzelne Markdown-Datei abgebildet wird.
1818

19-
## Editing or creating a documentation page
19+
## Dokumentationsseiten bearbeiten oder anlegen
2020

21-
To edit or create a new page you will need to:
21+
Um eine neue Seite anzulegen, ist Folgendes notwendig:
2222

23-
1. clone [the GitHub repository](https://github.com/bookwyrm-social/documentation)
24-
2. work in the `content` directory to make your changes - either editing an existing markdown page or creating a new one
25-
3. create a new Pull Request
26-
4. respond to any reviews with further edits
27-
5. enjoy seeing your updates instantly published when your pull request is approved and merged
23+
1. klone [das GitHub-Repository](https://github.com/bookwyrm-social/documentation)
24+
2. arbeite im `content`-Verzeichnis, um deine Änderungen vorzunehmen – indem du entweder eine bestehende Markdown-Seite anpasst oder eine neue erstellst
25+
3. erstelle eine neue Pull Request
26+
4. nimm weitere Änderungen vor, wenn du Rückmeldungen erhältst
27+
5. genieße, wie deine Änderungen sofort veröffentlicht werden, sobald deine Pull Request angenommen und gemerget wurde
2828

29-
If you have never used git or GitHub before, that may sound daunting, but let's break it down:
29+
Wenn du noch nie Git oder GitHub verwendet hast, mag das alles beängstigend klingen, aber lass es uns herunterbrechen:
3030

31-
### Clone the repository
31+
### Klone das Repository
3232

33-
1. Make sure you have [a GitHub account](https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github).
34-
2. Create a "clone" or "fork" of the Documentation repository:
33+
1. Stelle sicher, dass du [einen GitHub-Account](https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github) hast.
34+
2. Erstelle einen "Klon" oder "Fork" des Dokumentations-Repositorys:
3535

36-
- From the **web interface**, click "Fork" at the top of [this page](https://github.com/bookwyrm-social/documentation)
37-
- If you are using **GitHub Desktop**, follow [these instructions](https://docs.github.com/en/desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop)
38-
- If you are using the command line, run:
36+
- Auf der **Web-Oberfläche** klicke "Fork" am oberen Rand [dieser Seite](https://github.com/bookwyrm-social/documentation)
37+
- Wenn du **GitHub Desktop** verwendest, folge [diesen Anweisungen](https://docs.github.com/en/desktop/adding-and-cloning-repositories/cloning-and-forking-repositories-from-github-desktop)
38+
- Wenn du die Kommandozeile nutzt, führe aus:
3939

4040
`git clone https://github.com/bookwyrm-social/documentation.git`
4141

42-
### Create a new branch and make your edits
42+
### Einen neuen Branch erstellen und Änderungen vornehmen
4343

44-
To make changes:
44+
Um Änderungen vorzunehmen:
4545

46-
1. [Create a new branch](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/creating-a-branch-for-an-issue) in your fork
47-
2. Make your edits in the `content` directory and **commit** your changes:
48-
- [GitHub web interface](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files)
46+
1. [Erstelle einen neuen Branch](https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/creating-a-branch-for-an-issue) in deinem Fork
47+
2. Nimm deine Änderungen am `content`-Verzeichnis vor und **commite** sie:
48+
- [GitHub-Web-Oberfläche](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files)
4949
- [GitHub Desktop](https://docs.github.com/en/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop)
50-
- On the command line save your changes to the files and run `git commit`
50+
- In der Kommandozeile, speichere deine Änderungen an den Dateien und führe `git commit` aus
5151

52-
At this point you might want to see what your changes will look like when published. See [Building docs locally](#building-docs-locally) below for instruction on how to preview your changes.
52+
An dieser Stelle wirst du vielleicht sehen wollen, wie deine Änderungen aussehen, wenn sie veröffentlicht werden. Schau dir [Dokumentation lokal bauen](#building-docs-locally) weiter unten an, um zu erfahren, wie du eine Vorschau deiner Änderungen ansehen kannst.
5353

54-
### Create a pull request
54+
### Eine Pull Request erstellen
5555

56-
Once you have completed your changes, [make a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to the docs repository.
56+
Wenn deine Änderungen abgeschlossen sind, [erstelle eine Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) an das Dokumentations-Repository.
5757

58-
Your pull request will be reviewed and one of three things will happen:
58+
Deine Pull Request wird überprüft werden und eines der drei folgenden Szenarien wird eintreten:
5959

60-
1. It will be **merged** with no changes
61-
2. You will be asked to make **changes**
62-
3. It will be **rejected** and closed
60+
1. Sie wird ohne Änderungen **übernommen** (engl. merged)
61+
2. Du wirst gebeten, **Änderungen** vorzunehmen
62+
3. Sie wird **abgelehnt** und geschlossen
6363

64-
### Respond to reviews
64+
### Auf Überprüfungen reagieren
6565

66-
If you are asked to make changes, you can make them locally and `push` your local changes to your fork/clone on GitHub. This will automatically flow through to your pull request. Let the reviewer know when you have completed your updates so they can do another review and hopefully "pull" your changes.
66+
Wenn du gebeten wirst, Änderungen vorzunehmen, kannst du dies lokal erledigen und deine lokalen Änderungen an deinen Fork/Klon auf Github senden (engl. `push`). Sie werden dann automatisch in deine Pull Request übernommen. Lass den\*die Reviewer\*in wissen, wenn du mit deinen Anpassungen fertig bist, damit die Person eine weitere Überprüfung starten und dann hoffentlich deine Änderungen zu sich holen (engl. `pull`) kann.
6767

68-
We welcome all contributions. It would be unusual for a contribution to the docs to be rejected immediately. This would only happen if your pull request introduces information that is wrong or misleading with no chance of being improved, or if it has been declared out of scope.
68+
Wir heißen alle Beiträge willkommen. Es wäre ungewöhnlich, wenn ein Beitrag zur Dokumentation direkt abgelehnt würde. Das würde nur dann geschehen, wenn deine Pull Request Informationen einfügt, die falsch oder irreführend ohne Aussicht auf Besserung sind oder wenn festgestellt wird, dass sie aus dem Rahmen fällt.
6969

70-
### Your changes are published
70+
### Deine Änderungen werden veröffentlicht
7171

72-
When your pull request is merged, [the documentation](https://docs.joinbookwyrm.com/) is automatically updated. You may need to refresh your browser or use "incognito mode" to see the changes in your browser.
72+
Wenn deine Pull Request übernommen wird, wird [die Dokumentation](https://docs.joinbookwyrm.com/) automatisch aktualisiert. Es kann sein, dass du deinen Browser neu starten oder den "Inkognito-Modus" nutzen musst, um die Änderungen in deinem Browser zu sehen.
7373

74-
## New pages
74+
## Neue Seiten
7575

7676
If you are adding a new page, you will need to add some metadata and may need to adjust other pages.
7777

locale/de_DE/content/contributing/install-dev.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,51 +4,53 @@ Title: Entwicklungsumgebung Date: 2025-05-12 Order: 5
44

55
## Voraussetzungen
66

7-
Diese Anleitung geht davon aus, dass du BookWyrm mit Docker entwickelst. Du musst [Docker](https://docs.docker.com/engine/install/) und [docker-compose](https://docs.docker.com/compose/install/) installieren, bevor Du loslegst.
7+
Diese Anleitung geht davon aus, dass du BookWyrm mit Docker entwickelst. Du musst [Docker](https://docs.docker.com/engine/install/) und [docker-compose](https://docs.docker.com/compose/install/) installieren, bevor du loslegst.
8+
9+
_Wenn du zu BookWyrm beiträgst, ohne Docker zu verwenden, würden wir uns freuen, wenn du uns helfen würdest, [diese Anleitung zu aktualisieren](/documentation.html), damit sie auch eine Hilfestellung enthält, wie eine Entwicklungsumgebung ohne Docker aufgesetzt werden kann_.
810

911
## Entwicklungsumgebung einrichten
1012

11-
### Den Quellcode erhalten
13+
### Quellcode erhalten
1214

1315
1. Kopiere den [BookWyrm-Quellcode von GitHub](https://github.com/bookwyrm-social/bookwyrm). Du kannst [einen Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) des Projekts erstellen und [dann `git clone` ausführen, um den Quellcode](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) auf deinen Computer herunterzuladen.
14-
2. Gehe in das Verzeichnis, das den Quellcodeode auf Ihrem Computer enthält. Von jetzt an arbeitest Du aus diesem Verzeichnis heraus.
16+
2. Gehe in das Verzeichnis auf deinem Computer, das den Quellcode enthält. Von jetzt an arbeitest du in diesem Verzeichnis.
1517
3. Die Entwicklung wird auf dem `main`-Branch durchgeführt. Stelle also sicher, dass du diesen Branch ausgecheckt hast: `git checkout main`
16-
4. Erstelle eine Datei für Umgebungsvariablen für die Entwicklung durch Kopieren der Beispieldatei für Umgebungsvariablen (`.env.example`) in eine neue Datei namens `.env` ein. Falls Du die Kommandozeile nutzt, kannst du das wie folgt tun:
18+
4. Erstelle eine Datei mit Umgebungsvariablen für die Entwicklung, indem du die Beispieldatei (`.env.example`) kopierst und als neue Datei namens `.env` einfügst. In der Kommandozeile kannst du das wie folgt tun:
1719
``` { .sh }
1820
cp .env.example .env
1921
```
2022

21-
### Configure your environment settings
23+
### Umgebung konfigurieren
2224

23-
In `.env`:
25+
In der Datei `.env`:
2426

25-
4. change `DEBUG` to `true`
26-
5. If you use a tunneling/proxy service like [ngrok](https://ngrok.com), set `DOMAIN` to to the domain name you are using (e.g. `abcd-1234.ngrok-free.app`). Otherwise, set `DOMAIN` to `localhost`
27-
6. change `NGINX_SETUP` to `reverse_proxy` (this prevents BookWyrm trying to set up https certificates on your development machine)
28-
7. If you need to use a particular port (e.g. if you are tunneling via ngrok), uncomment `PORT` and set it (e.g. `PORT=1333`). If using `localhost` this is optional.
27+
4. Ändere `DEBUG` zu `true`
28+
5. Wenn du einen Tunneling-Dienst oder Proxy wie [ngrok](https://ngrok.com) verwendest, ändere die `DOMAIN` zu der Domain, die du verwendest (z. B. `abcd-1234.ngrok-free.app`). Andernfalls, ändere `DOMAIN` zu `localhost`
29+
6. Ändere `NGINX_SETUP` zu `reverse_proxy` (dies verhindert, dass BookWyrm versucht, HTTPS-Zertifikate auf deinem Entwicklungsgerät zu erstellen)
30+
7. Wenn du einen bestimmten Port verwenden möchtest (z. B. wenn du Anfragen durch ngrok tunnelst), entferne den Kommentar vor `PORT` und gib den Port an (z. B. `PORT=1333`). Wenn du `localhost` nutzt, ist dieser Schritt optional.
2931

30-
Check that you have [all the required settings configured](/environment.html#required-environment-settings) before proceeding.
32+
Prüfe, ob du [alle notwendigen Einstellungen getroffen hast](/environment.html#required-environment-settings), bevor du fortfährst.
3133

32-
If you try to register your admin account and see a message that `CSRF verification failed` you may have set your domain or port incorrectly.
34+
Wenn du versuchst, deinen Administrations-Account anzulegen, und eine Nachricht siehst, die `CSRF verification failed` lautet, kann es sein, dass du die Domain oder den Port falsch angegeben hast.
3335

34-
### Email (optional)
36+
### E-Mail (optional)
3537

36-
If you want to test sending emails, you will need to [set up appropriate real values](/environment.html#email-configuration) in the "Email config" section. You do not need to change anything for [the separate `EMAIL` setting](/environment.html#email).
38+
Wenn du ausprobieren möchtest, E-Mails zu versenden, wirst du [passende, echte Werte](/environment.html#email-configuration) im Bereich "E-Mail-Konfiguration" angeben müssen. Du musst nichts an der [separaten Einstellung `EMAIL`](/environment.html#email) ändern.
3739

38-
### Build and run
40+
### Bauen und ausführen
3941

4042
8. Führe Folgendes über die Kommandozeile aus:
4143

4244
``` { .sh }
43-
./bw-dev build # Build the docker images
44-
./bw-dev setup # Initialize the database and run migrations. Note the ADMIN key at the end of this output. You'll need it to register the first admin user.
45-
./bw-dev up # Start the docker containers
45+
./bw-dev build # Docker-Images bauen
46+
./bw-dev setup # Datenbank initialisieren und Migrationen ausführen. Notiere dir den Administrations-Schlüssel am Ende der Ausgabe. Du wirst ihn brauchen, um einen Administrations-Account anzulegen.
47+
./bw-dev up # Docker-Container starten
4648
```
4749

48-
9. Once the build is complete, you can access the instance at `http://localhost`, your ngrok domain, or `http://localhost:{PORT}`, depending on you domain and port configuration.
49-
10. You can now enter your admin key and create an admin user. From here everything is the same as described in "Running BookWyrm".
50+
9. Sobald der Build abgeschlossen ist, kannst du die Instanz unter `http://localhost`, unter deiner ngrok-Domain oder unter `http://localhost:{PORT}` erreichen, abhängig von deiner Domain- und Port-Einstellung.
51+
10. Du kannst nun deinen Administrations-Schlüssel eingeben und einen Administrations-Account anlegen. Ab hier funktioniert alles so, wie es in "BookWyrm betreiben" beschrieben ist.
5052

51-
Wenn du neugierig bist: das `./bw-dev` Kommando ist ein simples Shell-Script, das verschiedene Tools ansteuert: darüber hinaus könntest du es überspringen und direk `docker-compose build` oder `docker-compose up` laufen lassen, wenn du magst. `./bw-dev` sammelt sie einfach an einem gemeinsamen Ort zur Bequemlichkeit. Run it without arguments to get a list of available commands, read the [documentation page](/cli.html) for it, or open it up and look around to see exactly what each command is doing!
53+
Wenn du neugierig bist: Das `./bw-dev`-Kommando ist ein simples Shell-Script, das verschiedene andere Tools ansteuert. Du könntest es überspringen und direkt `docker-compose build` oder `docker-compose up` laufen lassen, wenn du möchtest. `./bw-dev` kombiniert diese Aufrufe der Einfachheit halber an einem gemeinsamen Ort. Führe das Skript ohne Argumente aus, um eine Liste der verfügbaren Kommandos zu erhalten, lies die [zugehörige Seite in der Dokumentation](/cli.html) oder öffne das Skript und sieh genau, was jedes Kommando tut!
5254

5355
## Modelle editieren oder erstellen
5456

@@ -65,4 +67,4 @@ Jedes Mal, wenn du CSS oder JavaScript bearbeitest, musst du Djangos `collectsta
6567
./bw-dev collectstatic
6668
```
6769

68-
Wenn du [yarn installierstt](https://yarnpkg.com/getting-started/install) haben, kannst du `yarn watch:static` ausführen, um das vorherige Skript bei jeder Änderung automatisch im Verzeichnis `bookwyrm/static` auszuführen.
70+
Wenn du [yarn installiert](https://yarnpkg.com/getting-started/install) hast, kannst du `yarn watch:static` ausführen, um das vorherige Skript bei jeder Änderung automatisch im Verzeichnis `bookwyrm/static` ausführen zu lassen.

locale/de_DE/content/running_bookwyrm/install-prod-dockerless.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ chown www-data:www-data /var/cache/nginx
5959
- Lade Nginx neu: `systemctl reload nginx`
6060
- Einrichtung der virtuellen Python-Umgebung
6161
- Make the python venv directory in your install dir: `python3 -m venv ./venv`
62-
- Installiere die Python-Abhängigkeiten für Bookwyrm via pip mit folgendem Befehl: `./venv/bin/pip3 install -r requirements.txt`
62+
- Install bookwyrm python dependencies with pip: `./venv/bin/pip3 install --upgrade "pip>=25.1.0"` `./venv/bin/pip3 install --group main`
6363
- Erstelle die Bookwyrm PostgreSQL-Datenbank. Make sure to change the password to what you set in the `.env` config: `sudo -i -u postgres psql`
6464

6565
``` { .sql }
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
Title: Updating Without Docker
3+
Date: 2023-01-29
4+
Order: 4
5+
---
6+
7+
Follow this guide if you have a BookWyrm installation without Docker and
8+
there are changes available in the production branch.
9+
10+
This guide assumes that your setup followed the latest [Installation without Docker](/install-prod-dockerless.html) guide.
11+
12+
Run all the following commands, except otherwise noted, as the `bookwyrm` user:
13+
14+
1. Pull in the latest changes on the `production` branch with `git pull`
15+
2. Install potential new Python dependencies:
16+
- `./venv/bin/pip3 install --upgrade "pip>=25.1.0"`
17+
- `./venv/bin/pip3 install --group main`
18+
3. Compile the themes with `venv/bin/python3 manage.py compile_themes`
19+
4. Collecting all the static files with `venv/bin/python3 manage.py collectstatic --no-input` – this also uploads them to [external storage](/external-storage.html) if you have this configured
20+
5. Migrate the database (it's advisable to create a backup before) with `venv/bin/python3 manage.py migrate`
21+
6. Restart the `systemd` services with `sudo systemctl restart bookwyrm bookwyrm-worker bookwyrm-scheduler`

locale/en_Oulipo/content/contributing/install-dev.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Title: Developer Environment Date: 2025-05-26 Order: 5
66

77
These instructions assume you are developing BookWyrm using Docker. You'll need to [install Docker](https://docs.docker.com/engine/install/) and [docker-compose](https://docs.docker.com/compose/install/) to get started.
88

9+
_If you are contributing to BookWyrm in a dockerless development environment we would love for you to [help us update this guide](/documentation.html) to include instructions for setting up a dockerless development environment_.
10+
911
## Setting up the developer environment
1012

1113
### Get the code

locale/en_Oulipo/content/running_bookwyrm/install-prod-dockerless.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ chown www-data:www-data /var/cache/nginx
5959
- Reload nginx: `systemctl reload nginx`
6060
- Setup the python virtual enviroment
6161
- Make the python venv directory in your install dir: `python3 -m venv ./venv`
62-
- Install bookwyrm python dependencies with pip: `./venv/bin/pip3 install -r requirements.txt`
62+
- Install bookwyrm python dependencies with pip: `./venv/bin/pip3 install --upgrade "pip>=25.1.0"` `./venv/bin/pip3 install --group main`
6363
- Make the bookwyrm postgresql database. Make sure to change the password to what you set in the `.env` config: `sudo -i -u postgres psql`
6464

6565
``` { .sql }

0 commit comments

Comments
 (0)