Skip to content

Commit f1efedc

Browse files
BookWyrm Botgithub-actions[bot]
authored andcommitted
deploy versions
1 parent a363be2 commit f1efedc

File tree

201 files changed

+3362
-172
lines changed

Some content is hidden

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

201 files changed

+3362
-172
lines changed
778 Bytes
Binary file not shown.

locale/de_DE/content/contributing/documentation.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,7 @@ Locales for the language dropdown are listed in `i18n.py`. Generally we wait for
144144

145145
When a new version of BookWyrm is released we need to create a new version of the docs:
146146

147-
1. Add a new branch with a name exactly matching the new version tag in BookWyrm. e.g. `v0.8.0`.
148-
149-
2. Add that branch name to the list of versions in `generate.py` in the `main` branch of the docs
150-
151-
3. Check out every other version in turn, and merge the updated generation file into it so they all have the new branch listed: `git checkout main generate.py`. Then commit this change, create a PR to merge this change into the version's branch in the docs, and merge it. This will ensure that all pages in all versions of the docs have every other version listed in the dropdown menu.
152-
153-
4. Merge the change in the `main` branch last - only merges into `main` trigger the GitHub action to deploy to the docs web server so if you do this first, the changes in other branches will have no effect.
147+
1. Add a new branch with a name exactly matching the new version tag in BookWyrm. e.g. `v0.x.y`.
148+
2. Add that branch name to the list of versions in `generate.py`, and push your new branch to the repository.
149+
3. Check out every other version in turn, and merge the updated `generate.py` file into it so they all have the new branch listed: `git checkout v0.x.y generate.py`. Then commit this change, create a PR to merge this change into the version's branch in the docs, and merge it. This will ensure that all pages in all versions of the docs have every other version listed in the dropdown menu.
150+
4. Merge the new `generate.py` in the `main` branch last - only merges into `main` trigger the GitHub action to deploy to the docs web server so if you do this first, the changes in other branches will have no effect until next time you update `main`.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
Title: Management Commands
3+
Date: 2023-04-26
4+
Order: 11
5+
---
6+
7+
In the `bookwyrm/management/commands` directory there are some commands to manipulate the instance’s database. Some of them are documented here.
8+
9+
## Merging objects
10+
11+
Quite often an instance will end up with duplicate books and authors or editions that appear as separate books when they are actually just different editions of the same work. This can happen because of importing editions that don’t have shared identifiers or from user mistakes. There also was a bug prior to version 0.7.5 which created a large number of duplicate books, editions, and authors. Sadly there’s no user interface to correct this for the time being, but in cases where the books are important for your instance you can use these management commands to fix some of the problems if you are using at least version 0.6.2.
12+
13+
Please take extra care when using these commands because if you make a mistake there’s no way to undo it.
14+
15+
### Merging editions
16+
17+
If an edition of a book appears twice in the database and you are sure they are actually both referring to same edition, you can combine them into one with a command like this:
18+
19+
```
20+
./bw-dev runweb python manage.py merge_editions --canonical=27 --other=38
21+
```
22+
23+
This will copy any missing information from edition 38 (the “other” edition) over to edition 27 (the “canonical” edition) and then delete the other edition. If any field of information is in both editions then the data from the canonical edition will be kept. If the other edition is in any lists or has any comments or reviews etc then these will all be updated to point to the canonical edition instead.
24+
25+
You can find the numbers to use in the command by visiting the page for a book and looking at the number in the URL.
26+
27+
### Merging authors
28+
29+
You can identify potential duplicate authors with `show_duplicate_authors`:
30+
31+
```sh
32+
./bw-dev runweb python manage.py show_duplicate_authors
33+
```
34+
35+
This will list all your _potential_ duplicate author records, based purely on their name, showing their birth and death dates if available, the count of books for each author, and a link to their page on your instance. Note that **you must check that these are actually duplicates** before merging them as they may be different authors with the same name.
36+
37+
Once confirmed, if an author is duplicated you can combine the two authors into one with a command like this:
38+
39+
```sh
40+
./bw-dev runweb python manage.py merge_authors --canonical=7 --other=46
41+
```
42+
43+
As for the editions, any extra information from the other author will be copied over to the canonical author and then the other author will be deleted. Any books written by the other author will be changed to be written by the canonical author. You can find the numbers to use in the command by visiting the page for an author and looking at the number in the URL.
44+
45+
## Fixing ISBNs
46+
47+
There was a bug in `v0.8.0` which erroneously created 11-digit ISBN10 entries in some circumstances. This was fixed in a data migration in `v0.8.1`, however for various reasons you may need to manually run a cleanup command to fix any incorrect ISBNs in your local database:
48+
49+
```sh
50+
./bw-dev runweb python manage.py fix_isbn10_entries
51+
```
0 Bytes
Binary file not shown.

locale/en_Oulipo/content/contributing/documentation.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,7 @@ Locales for the language dropdown are listed in `i18n.py`. Generally we wait for
144144

145145
When a new version of BookWyrm is released we need to create a new version of the docs:
146146

147-
1. Add a new branch with a name exactly matching the new version tag in BookWyrm. e.g. `v0.8.0`.
148-
149-
2. Add that branch name to the list of versions in `generate.py` in the `main` branch of the docs
150-
151-
3. Check out every other version in turn, and merge the updated generation file into it so they all have the new branch listed: `git checkout main generate.py`. Then commit this change, create a PR to merge this change into the version's branch in the docs, and merge it. This will ensure that all pages in all versions of the docs have every other version listed in the dropdown menu.
152-
153-
4. Merge the change in the `main` branch last - only merges into `main` trigger the GitHub action to deploy to the docs web server so if you do this first, the changes in other branches will have no effect.
147+
1. Add a new branch with a name exactly matching the new version tag in BookWyrm. e.g. `v0.x.y`.
148+
2. Add that branch name to the list of versions in `generate.py`, and push your new branch to the repository.
149+
3. Check out every other version in turn, and merge the updated `generate.py` file into it so they all have the new branch listed: `git checkout v0.x.y generate.py`. Then commit this change, create a PR to merge this change into the version's branch in the docs, and merge it. This will ensure that all pages in all versions of the docs have every other version listed in the dropdown menu.
150+
4. Merge the new `generate.py` in the `main` branch last - only merges into `main` trigger the GitHub action to deploy to the docs web server so if you do this first, the changes in other branches will have no effect until next time you update `main`.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
Title: Management Commands
3+
Date: 2023-04-26
4+
Order: 11
5+
---
6+
7+
In the `bookwyrm/management/commands` directory there are some commands to manipulate the instance’s database. Some of them are documented here.
8+
9+
## Merging objects
10+
11+
Quite often an instance will end up with duplicate books and authors or editions that appear as separate books when they are actually just different editions of the same work. This can happen because of importing editions that don’t have shared identifiers or from user mistakes. There also was a bug prior to version 0.7.5 which created a large number of duplicate books, editions, and authors. Sadly there’s no user interface to correct this for the time being, but in cases where the books are important for your instance you can use these management commands to fix some of the problems if you are using at least version 0.6.2.
12+
13+
Please take extra care when using these commands because if you make a mistake there’s no way to undo it.
14+
15+
### Merging editions
16+
17+
If an edition of a book appears twice in the database and you are sure they are actually both referring to same edition, you can combine them into one with a command like this:
18+
19+
```
20+
./bw-dev runweb python manage.py merge_editions --canonical=27 --other=38
21+
```
22+
23+
This will copy any missing information from edition 38 (the “other” edition) over to edition 27 (the “canonical” edition) and then delete the other edition. If any field of information is in both editions then the data from the canonical edition will be kept. If the other edition is in any lists or has any comments or reviews etc then these will all be updated to point to the canonical edition instead.
24+
25+
You can find the numbers to use in the command by visiting the page for a book and looking at the number in the URL.
26+
27+
### Merging authors
28+
29+
You can identify potential duplicate authors with `show_duplicate_authors`:
30+
31+
```sh
32+
./bw-dev runweb python manage.py show_duplicate_authors
33+
```
34+
35+
This will list all your _potential_ duplicate author records, based purely on their name, showing their birth and death dates if available, the count of books for each author, and a link to their page on your instance. Note that **you must check that these are actually duplicates** before merging them as they may be different authors with the same name.
36+
37+
Once confirmed, if an author is duplicated you can combine the two authors into one with a command like this:
38+
39+
```sh
40+
./bw-dev runweb python manage.py merge_authors --canonical=7 --other=46
41+
```
42+
43+
As for the editions, any extra information from the other author will be copied over to the canonical author and then the other author will be deleted. Any books written by the other author will be changed to be written by the canonical author. You can find the numbers to use in the command by visiting the page for an author and looking at the number in the URL.
44+
45+
## Fixing ISBNs
46+
47+
There was a bug in `v0.8.0` which erroneously created 11-digit ISBN10 entries in some circumstances. This was fixed in a data migration in `v0.8.1`, however for various reasons you may need to manually run a cleanup command to fix any incorrect ISBNs in your local database:
48+
49+
```sh
50+
./bw-dev runweb python manage.py fix_isbn10_entries
51+
```

locale/en_US/LC_MESSAGES/messages.po

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ msgid ""
88
msgstr ""
99
"Project-Id-Version: PACKAGE VERSION\n"
1010
"Report-Msgid-Bugs-To: \n"
11-
"POT-Creation-Date: 2025-07-05 04:19+0000\n"
11+
"POT-Creation-Date: 2026-01-18 03:41+0000\n"
1212
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
1313
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
1414
"Language-Team: LANGUAGE <LL@li.org>\n"
@@ -56,51 +56,66 @@ msgstr ""
5656
#: templates/layout.html:47 templates/layout.html:124 templates/layout.html:51
5757
#: templates/layout.html:130 templates/layout.html:52 templates/layout.html:131
5858
#: templates/layout.html:137 templates/layout.html:35 templates/layout.html:138
59+
#: templates/layout.html:149
5960
msgid "Documentation"
6061
msgstr ""
6162

6263
#: templates/layout.html:95 templates/layout.html:101 templates/layout.html:102
6364
#: templates/layout.html:108 templates/layout.html:109
65+
#: templates/layout.html:120
6466
msgid "<strong>BookWyrm</strong> is collaborative, anti-corporate software maintained by <a href='https://www.mousereeve.com/'>Mouse Reeve</a>."
6567
msgstr ""
6668

6769
#: templates/layout.html:98 templates/layout.html:104 templates/layout.html:105
6870
#: templates/layout.html:111 templates/layout.html:112
71+
#: templates/layout.html:123
6972
msgid "Support BookWyrm on <a href='https://www.patreon.com/bookwyrm' target='_blank'>Patreon</a>."
7073
msgstr ""
7174

7275
#: templates/layout.html:102 templates/layout.html:108
7376
#: templates/layout.html:109 templates/layout.html:115
74-
#: templates/layout.html:116
77+
#: templates/layout.html:116 templates/layout.html:127
7578
msgid "Get Involved"
7679
msgstr ""
7780

7881
#: templates/layout.html:104 templates/layout.html:110
7982
#: templates/layout.html:111 templates/layout.html:117
80-
#: templates/layout.html:118
83+
#: templates/layout.html:118 templates/layout.html:129
8184
msgid "BookWyrm on GitHub"
8285
msgstr ""
8386

8487
#: templates/layout.html:107 templates/layout.html:113
8588
#: templates/layout.html:114 templates/layout.html:120
86-
#: templates/layout.html:121
89+
#: templates/layout.html:121 templates/layout.html:132
8790
msgid "Contribute to this page"
8891
msgstr ""
8992

9093
#: templates/layout.html:122 templates/layout.html:128
9194
#: templates/layout.html:129 templates/layout.html:135
92-
#: templates/layout.html:136
95+
#: templates/layout.html:136 templates/layout.html:147
9396
msgid "Learn more"
9497
msgstr ""
9598

9699
#: templates/layout.html:127 templates/layout.html:133
97100
#: templates/layout.html:134 templates/layout.html:140
98-
#: templates/layout.html:141
101+
#: templates/layout.html:141 templates/layout.html:152
99102
msgid "Contact maintainer"
100103
msgstr ""
101104

102105
#: templates/layout.html:130 templates/layout.html:136
103106
#: templates/layout.html:137 templates/layout.html:143
104-
#: templates/layout.html:144
107+
#: templates/layout.html:144 templates/layout.html:155
105108
msgid "License"
106109
msgstr ""
110+
111+
#: templates/layout.html:65
112+
msgid "This is the documentation for the current development code. Choose a version from the menu to see documentation for released versions since"
113+
msgstr ""
114+
115+
#: templates/layout.html:115
116+
msgid "Can't find what you are looking for, or see something wrong? <a href='https://github.com/bookwyrm-social/documentation/issues'>Log an Issue to help us improve this documentation!</a>"
117+
msgstr ""
118+
119+
#: templates/page.html:16
120+
msgid "Page Contents"
121+
msgstr ""
0 Bytes
Binary file not shown.

locale/es_ES/content/contributing/documentation.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,7 @@ Locales for the language dropdown are listed in `i18n.py`. Generally we wait for
144144

145145
When a new version of BookWyrm is released we need to create a new version of the docs:
146146

147-
1. Add a new branch with a name exactly matching the new version tag in BookWyrm. e.g. `v0.8.0`.
148-
149-
2. Add that branch name to the list of versions in `generate.py` in the `main` branch of the docs
150-
151-
3. Check out every other version in turn, and merge the updated generation file into it so they all have the new branch listed: `git checkout main generate.py`. Then commit this change, create a PR to merge this change into the version's branch in the docs, and merge it. This will ensure that all pages in all versions of the docs have every other version listed in the dropdown menu.
152-
153-
4. Merge the change in the `main` branch last - only merges into `main` trigger the GitHub action to deploy to the docs web server so if you do this first, the changes in other branches will have no effect.
147+
1. Add a new branch with a name exactly matching the new version tag in BookWyrm. e.g. `v0.x.y`.
148+
2. Add that branch name to the list of versions in `generate.py`, and push your new branch to the repository.
149+
3. Check out every other version in turn, and merge the updated `generate.py` file into it so they all have the new branch listed: `git checkout v0.x.y generate.py`. Then commit this change, create a PR to merge this change into the version's branch in the docs, and merge it. This will ensure that all pages in all versions of the docs have every other version listed in the dropdown menu.
150+
4. Merge the new `generate.py` in the `main` branch last - only merges into `main` trigger the GitHub action to deploy to the docs web server so if you do this first, the changes in other branches will have no effect until next time you update `main`.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
Title: Management Commands
3+
Date: 2023-04-26
4+
Order: 11
5+
---
6+
7+
In the `bookwyrm/management/commands` directory there are some commands to manipulate the instance’s database. Some of them are documented here.
8+
9+
## Merging objects
10+
11+
Quite often an instance will end up with duplicate books and authors or editions that appear as separate books when they are actually just different editions of the same work. This can happen because of importing editions that don’t have shared identifiers or from user mistakes. There also was a bug prior to version 0.7.5 which created a large number of duplicate books, editions, and authors. Sadly there’s no user interface to correct this for the time being, but in cases where the books are important for your instance you can use these management commands to fix some of the problems if you are using at least version 0.6.2.
12+
13+
Please take extra care when using these commands because if you make a mistake there’s no way to undo it.
14+
15+
### Merging editions
16+
17+
If an edition of a book appears twice in the database and you are sure they are actually both referring to same edition, you can combine them into one with a command like this:
18+
19+
```
20+
./bw-dev runweb python manage.py merge_editions --canonical=27 --other=38
21+
```
22+
23+
This will copy any missing information from edition 38 (the “other” edition) over to edition 27 (the “canonical” edition) and then delete the other edition. If any field of information is in both editions then the data from the canonical edition will be kept. If the other edition is in any lists or has any comments or reviews etc then these will all be updated to point to the canonical edition instead.
24+
25+
You can find the numbers to use in the command by visiting the page for a book and looking at the number in the URL.
26+
27+
### Merging authors
28+
29+
You can identify potential duplicate authors with `show_duplicate_authors`:
30+
31+
```sh
32+
./bw-dev runweb python manage.py show_duplicate_authors
33+
```
34+
35+
This will list all your _potential_ duplicate author records, based purely on their name, showing their birth and death dates if available, the count of books for each author, and a link to their page on your instance. Note that **you must check that these are actually duplicates** before merging them as they may be different authors with the same name.
36+
37+
Once confirmed, if an author is duplicated you can combine the two authors into one with a command like this:
38+
39+
```sh
40+
./bw-dev runweb python manage.py merge_authors --canonical=7 --other=46
41+
```
42+
43+
As for the editions, any extra information from the other author will be copied over to the canonical author and then the other author will be deleted. Any books written by the other author will be changed to be written by the canonical author. You can find the numbers to use in the command by visiting the page for an author and looking at the number in the URL.
44+
45+
## Fixing ISBNs
46+
47+
There was a bug in `v0.8.0` which erroneously created 11-digit ISBN10 entries in some circumstances. This was fixed in a data migration in `v0.8.1`, however for various reasons you may need to manually run a cleanup command to fix any incorrect ISBNs in your local database:
48+
49+
```sh
50+
./bw-dev runweb python manage.py fix_isbn10_entries
51+
```

0 commit comments

Comments
 (0)